sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class MediaAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $entity=null,

        // @DataMember(Order=5)
        /** @var int */
        public int $entityId=0,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $mediaType=null,

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $mediaPath=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $questionnairsId=null,

        // @DataMember(Order=9)
        /** @var string|null */
        public ?string $name=null,

        // @DataMember(Order=10)
        /** @var bool|null */
        public ?bool $free=null,

        // @DataMember(Order=11)
        /** @var string */
        public string $publicAccessGuid='',

        // @DataMember(Order=12)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['entity'])) $this->entity = $o['entity'];
        if (isset($o['entityId'])) $this->entityId = $o['entityId'];
        if (isset($o['mediaType'])) $this->mediaType = $o['mediaType'];
        if (isset($o['mediaPath'])) $this->mediaPath = $o['mediaPath'];
        if (isset($o['questionnairsId'])) $this->questionnairsId = $o['questionnairsId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['free'])) $this->free = $o['free'];
        if (isset($o['publicAccessGuid'])) $this->publicAccessGuid = $o['publicAccessGuid'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->entity)) $o['entity'] = $this->entity;
        if (isset($this->entityId)) $o['entityId'] = $this->entityId;
        if (isset($this->mediaType)) $o['mediaType'] = $this->mediaType;
        if (isset($this->mediaPath)) $o['mediaPath'] = $this->mediaPath;
        if (isset($this->questionnairsId)) $o['questionnairsId'] = $this->questionnairsId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->free)) $o['free'] = $this->free;
        if (isset($this->publicAccessGuid)) $o['publicAccessGuid'] = $this->publicAccessGuid;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class MediaAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $entity='',

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $entityId=0,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $mediaType='',

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $mediaPath=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $questionnairsId=null,

        // @DataMember(Order=9)
        /** @var string|null */
        public ?string $name=null,

        // @DataMember(Order=10)
        /** @var bool|null */
        public ?bool $free=null,

        // @DataMember(Order=11)
        /** @var string */
        public string $publicAccessGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['entity'])) $this->entity = $o['entity'];
        if (isset($o['entityId'])) $this->entityId = $o['entityId'];
        if (isset($o['mediaType'])) $this->mediaType = $o['mediaType'];
        if (isset($o['mediaPath'])) $this->mediaPath = $o['mediaPath'];
        if (isset($o['questionnairsId'])) $this->questionnairsId = $o['questionnairsId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['free'])) $this->free = $o['free'];
        if (isset($o['publicAccessGuid'])) $this->publicAccessGuid = $o['publicAccessGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->entity)) $o['entity'] = $this->entity;
        if (isset($this->entityId)) $o['entityId'] = $this->entityId;
        if (isset($this->mediaType)) $o['mediaType'] = $this->mediaType;
        if (isset($this->mediaPath)) $o['mediaPath'] = $this->mediaPath;
        if (isset($this->questionnairsId)) $o['questionnairsId'] = $this->questionnairsId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->free)) $o['free'] = $this->free;
        if (isset($this->publicAccessGuid)) $o['publicAccessGuid'] = $this->publicAccessGuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MediaAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /media HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MediaAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <Entity>String</Entity>
  <EntityId>0</EntityId>
  <MediaType>String</MediaType>
  <MediaPath>String</MediaPath>
  <QuestionnairsId>0</QuestionnairsId>
  <Name>String</Name>
  <Free>false</Free>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
</MediaAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MediaAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Entity>String</Entity>
  <EntityId>0</EntityId>
  <Free>false</Free>
  <MediaPath>String</MediaPath>
  <MediaType>String</MediaType>
  <Name>String</Name>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <QuestionnairsId>0</QuestionnairsId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TenantsId>0</TenantsId>
</MediaAddResponse>