Platform API

GetAttachments

The following routes are available for this service:
All Verbs	/api/attachments/{ConnectedObjectId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetAttachments
{
    /**
    * 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")
    open var ConnectedObjectId:UUID? = null
}

@ApiResponse(Description="Returns list of attachments linked to an object.")
open class GetAttachmentsResponse
{
    open var Attachments:ArrayList<MediaModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class MediaModel
{
    open var MediaFileId:UUID? = null
    open var MediaName:String? = null
    open var FileContent:String? = null
    open var FileContentType:String? = null
    open var FilePath:String? = null
    open var OriginalFileName:String? = null
    open var ImageWidth:Int? = null
    open var ImageHeight:Int? = null
    open var FileSizeKB:Int? = null
    open var BlobUriRaw:String? = null
    open var BlobUriFull:String? = null
    open var BlobUriThumbnail:String? = null
    open var WatermarkUri:String? = null
    open var CapturedDate:Date? = null
    open var CapturedByContactId:UUID? = null
    open var CapturedByContactName:String? = null
    open var CapturedByContactThumbnailUrl:String? = null
    open var Notes:String? = null
    open var ResourceActionName:String? = null
    open var LocationVerified:String? = null
    open var TrafficLightLocationVerified:UUID? = null
    open var AudienceLevel:String? = null
    open var WorksFor:String? = null
}

Kotlin GetAttachments 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 /api/attachments/{ConnectedObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAttachments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ConnectedObjectId>00000000-0000-0000-0000-000000000000</ConnectedObjectId>
</GetAttachments>

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

<GetAttachmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:MediaModel>
      <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>
    </d2p1:MediaModel>
  </Attachments>
  <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>
</GetAttachmentsResponse>