sfgboxapi

<back to all web services

MediaEdit

Requires Authentication
The following routes are available for this service:
PUT/media/{Id}

export class MediaEditResponse
{
    // @DataMember(Order=1)
    public id: number;

    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=4)
    public entity: string;

    // @DataMember(Order=5)
    public entityId: number;

    // @DataMember(Order=6)
    public mediaType: string;

    // @DataMember(Order=7)
    public mediaPath?: string;

    // @DataMember(Order=8)
    public questionnairsId?: number;

    // @DataMember(Order=9)
    public name: string;

    // @DataMember(Order=10)
    public free: boolean;

    // @DataMember(Order=11)
    public publicAccessGuid: string;

    // @DataMember(Order=12)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<MediaEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class MediaEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public id: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public entity: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public entityId: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public mediaType: string;

    // @DataMember(Order=7)
    public mediaPath?: string;

    // @DataMember(Order=8)
    public questionnairsId?: number;

    // @DataMember(Order=9)
    public name: string;

    // @DataMember(Order=10)
    public free: boolean;

    // @DataMember(Order=11)
    public publicAccessGuid: string;

    public constructor(init?: Partial<MediaEdit>) { (Object as any).assign(this, init); }
}

TypeScript MediaEdit 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.

PUT /media/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MediaEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <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>
</MediaEdit>

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

<MediaEditResponse 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>
  <Id>0</Id>
  <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>
</MediaEditResponse>