Platform API

<back to all web services

AddAttachments

Requires Authentication
The following routes are available for this service:
POST/api/attachments
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AddAttachments
{
    /**
    *  including file content, file type, content type and connected object.
    */
    @ApiMember(DataType="string", Description=" including file content, file type, content type and connected object.", Name="Files", ParameterType="query")
    open var Files:ArrayList<MediaModel>? = null

    /**
    * 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")
    open var ApplianceId:UUID? = null

    /**
    * 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

    /**
    * Licensee Id of the Object owner for which primary image is to be uploaded.
    */
    @ApiMember(DataType="Guid", Description="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectLicenseeId")
    open var ConnectedObjectLicenseeId:UUID? = 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
}

open class AddAttachmentsResponse
{
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin AddAttachments DTOs

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

HTTP + OTHER

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

POST /api/attachments HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Files":[{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","FileContent":"String","FileContentType":"String","FilePath":"String","OriginalFileName":"String","ImageWidth":0,"ImageHeight":0,"FileSizeKB":0,"BlobUriRaw":"String","BlobUriFull":"String","BlobUriThumbnail":"String","WatermarkUri":"String","CapturedDate":"0001-01-01T00:00:00.0000000","CapturedByContactId":"00000000000000000000000000000000","CapturedByContactName":"String","CapturedByContactThumbnailUrl":"String","Notes":"String","ResourceActionName":"String","LocationVerified":"String","TrafficLightLocationVerified":"00000000-0000-0000-0000-000000000000","AudienceLevel":"String","WorksFor":"String"}],"ApplianceId":"00000000-0000-0000-0000-000000000000","ConnectedObjectId":"00000000-0000-0000-0000-000000000000","ConnectedObjectLicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}