Platform API

<back to all web services

ManagePrimaryImage

"use strict";
export class SaveMediaResponse {
    /** @param {{ErosMediaFileId?:string,MediaName?:string,OriginalFileName?:string,MediaFileUrl?:string,MediaFileThumbnailUrl?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Media File Guid */
    ErosMediaFileId;
    /**
     * @type {string}
     * @description Media File Name */
    MediaName;
    /**
     * @type {string}
     * @description The original name of the media being saved. */
    OriginalFileName;
    /**
     * @type {string}
     * @description Url of the media file. */
    MediaFileUrl;
    /**
     * @type {string}
     * @description Url of the media file thumbnail. */
    MediaFileThumbnailUrl;
    /**
     * @type {ResponseStatus}
     * @description Service Stack Response Status. */
    ResponseStatus;
}
export class MediaModel {
    /** @param {{MediaFileId?:string,MediaName?:string,FileContent?:string,FileContentType?:string,FilePath?:string,OriginalFileName?:string,ImageWidth?:number,ImageHeight?:number,FileSizeKB?:number,BlobUriRaw?:string,BlobUriFull?:string,BlobUriThumbnail?:string,WatermarkUri?:string,CapturedDate?:string,CapturedByContactId?:string,CapturedByContactName?:string,CapturedByContactThumbnailUrl?:string,Notes?:string,ResourceActionName?:string,LocationVerified?:string,TrafficLightLocationVerified?:string,AudienceLevel?:string,WorksFor?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MediaFileId;
    /** @type {string} */
    MediaName;
    /** @type {string} */
    FileContent;
    /** @type {string} */
    FileContentType;
    /** @type {string} */
    FilePath;
    /** @type {string} */
    OriginalFileName;
    /** @type {number} */
    ImageWidth;
    /** @type {number} */
    ImageHeight;
    /** @type {number} */
    FileSizeKB;
    /** @type {string} */
    BlobUriRaw;
    /** @type {string} */
    BlobUriFull;
    /** @type {string} */
    BlobUriThumbnail;
    /** @type {string} */
    WatermarkUri;
    /** @type {string} */
    CapturedDate;
    /** @type {?string} */
    CapturedByContactId;
    /** @type {string} */
    CapturedByContactName;
    /** @type {string} */
    CapturedByContactThumbnailUrl;
    /** @type {string} */
    Notes;
    /** @type {string} */
    ResourceActionName;
    /** @type {string} */
    LocationVerified;
    /** @type {string} */
    TrafficLightLocationVerified;
    /** @type {string} */
    AudienceLevel;
    /** @type {string} */
    WorksFor;
}
export class ManagePrimaryImage {
    /** @param {{ContactIdOwner?:string,File?:MediaModel,ApplianceId?:string,ContainerName?:string,ConnectedObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The licensee's contact Id linked to the media file. */
    ContactIdOwner;
    /**
     * @type {MediaModel}
     * @description Primary image file to be uploaded including file type and content type. */
    File;
    /**
     * @type {string}
     * @description Appliance from which primary image file is to be uploaded. */
    ApplianceId;
    /**
     * @type {string}
     * @description Blob storage container to which primary image file is to be uploaded. */
    ContainerName;
    /**
     * @type {string}
     * @description Object for which primary image is to be uploaded. */
    ConnectedObjectId;
}

JavaScript ManagePrimaryImage DTOs

POST /api/primaryimage HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ManagePrimaryImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
  <ConnectedObjectId>00000000-0000-0000-0000-000000000000</ConnectedObjectId>
  <ContactIdOwner>00000000-0000-0000-0000-000000000000</ContactIdOwner>
  <ContainerName>String</ContainerName>
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:AudienceLevel>String</d2p1:AudienceLevel>
    <d2p1:BlobUriFull>String</d2p1:BlobUriFull>
    <d2p1:BlobUriRaw>String</d2p1:BlobUriRaw>
    <d2p1:BlobUriThumbnail>String</d2p1:BlobUriThumbnail>
    <d2p1:CapturedByContactId>00000000-0000-0000-0000-000000000000</d2p1:CapturedByContactId>
    <d2p1:CapturedByContactName>String</d2p1:CapturedByContactName>
    <d2p1:CapturedByContactThumbnailUrl>String</d2p1:CapturedByContactThumbnailUrl>
    <d2p1:CapturedDate>0001-01-01T00:00:00</d2p1:CapturedDate>
    <d2p1:FileContent>String</d2p1:FileContent>
    <d2p1:FileContentType>String</d2p1:FileContentType>
    <d2p1:FilePath>String</d2p1:FilePath>
    <d2p1:FileSizeKB>0</d2p1:FileSizeKB>
    <d2p1:ImageHeight>0</d2p1:ImageHeight>
    <d2p1:ImageWidth>0</d2p1:ImageWidth>
    <d2p1:LocationVerified>String</d2p1:LocationVerified>
    <d2p1:MediaFileId>00000000-0000-0000-0000-000000000000</d2p1:MediaFileId>
    <d2p1:MediaName>String</d2p1:MediaName>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:OriginalFileName>String</d2p1:OriginalFileName>
    <d2p1:ResourceActionName>String</d2p1:ResourceActionName>
    <d2p1:TrafficLightLocationVerified>00000000-0000-0000-0000-000000000000</d2p1:TrafficLightLocationVerified>
    <d2p1:WatermarkUri>String</d2p1:WatermarkUri>
    <d2p1:WorksFor>String</d2p1:WorksFor>
  </File>
</ManagePrimaryImage>

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

<SaveMediaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ErosMediaFileId>00000000-0000-0000-0000-000000000000</ErosMediaFileId>
  <MediaFileThumbnailUrl>String</MediaFileThumbnailUrl>
  <MediaFileUrl>String</MediaFileUrl>
  <MediaName>String</MediaName>
  <OriginalFileName>String</OriginalFileName>
  <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>
</SaveMediaResponse>