Platform API

<back to all web services

ManagePrimaryImage

export class SaveMediaResponse
{
    /** @description Media File Guid */
    // @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    public ErosMediaFileId: string;

    /** @description Media File Name */
    // @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
    public MediaName: string;

    /** @description The original name of the media being saved. */
    // @ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")
    public OriginalFileName: string;

    /** @description Url of the media file. */
    // @ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")
    public MediaFileUrl: string;

    /** @description Url of the media file thumbnail. */
    // @ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")
    public MediaFileThumbnailUrl: string;

    /** @description Service Stack Response Status. */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public ResponseStatus: ResponseStatus;

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

export class MediaModel
{
    public MediaFileId: string;
    public MediaName: string;
    public FileContent: string;
    public FileContentType: string;
    public FilePath: string;
    public OriginalFileName: string;
    public ImageWidth: number;
    public ImageHeight: number;
    public FileSizeKB: number;
    public BlobUriRaw: string;
    public BlobUriFull: string;
    public BlobUriThumbnail: string;
    public WatermarkUri: string;
    public CapturedDate: string;
    public CapturedByContactId?: string;
    public CapturedByContactName: string;
    public CapturedByContactThumbnailUrl: string;
    public Notes: string;
    public ResourceActionName: string;
    public LocationVerified: string;
    public TrafficLightLocationVerified: string;
    public AudienceLevel: string;
    public WorksFor: string;

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

export class ManagePrimaryImage
{
    /** @description The licensee's contact Id linked to the media file. */
    // @ApiMember(DataType="Guid", Description="The licensee's contact Id linked to the media file.", IsRequired=true, Name="ContactIdOwner", ParameterType="query")
    public ContactIdOwner: string;

    /** @description Primary image file to be uploaded including file type and content type. */
    // @ApiMember(DataType="MediaModel", Description="Primary image file to be uploaded including file type and content type.", IsRequired=true, Name="File")
    public File: MediaModel;

    /** @description Appliance from which primary image file is to be uploaded. */
    // @ApiMember(DataType="Guid", Description="Appliance from which primary image file is to be uploaded.", IsRequired=true, Name="ApplianceId")
    public ApplianceId: string;

    /** @description Blob storage container to which primary image file is to be uploaded. */
    // @ApiMember(DataType="Guid", Description="Blob storage container to which primary image file is to be uploaded.", IsRequired=true, Name="ContainerName")
    public ContainerName: string;

    /** @description Object for which primary image is to be uploaded. */
    // @ApiMember(DataType="Guid", Description="Object for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectId")
    public ConnectedObjectId: string;

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

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