POST CloudStorageDocument/UploadCloudDocument

Uploads a new Cloud Document.

Request Information

URI Parameters

Body Parameters

Cloud Document object used to upload and connect to the Agvance transaction.

ClsUploadDocument
NameDescriptionTypeAdditional Information
TransactionGuid

The GUID of the trasaction to tie this document to

 globally unique identifier

Required
DocumentType

The type of transaction that this document is for

 CloudDocumentEnum

Required
FileName

The user friendly pdf filename for this document Must end with '.pdf'

 string

Required

Max length: 250

Must not contain invalid characters which include: & ! * = > < ? \ / | ' : "
FileContentAsBase64String

The Base64 string of the file

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "TransactionGuid": "109061be-45aa-4169-b208-d79b819519a9",
  "DocumentType": 0,
  "FileName": "sample string 5",
  "FileContentAsBase64String": "sample string 6"
}

application/xml, text/xml

Sample: 
<ClsCloudDocument.ClsUploadDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Interfaces">
  <DocumentType>None</DocumentType>
  <FileContentAsBase64String>sample string 6</FileContentAsBase64String>
  <FileName>sample string 5</FileName>
  <TransactionGuid>109061be-45aa-4169-b208-d79b819519a9</TransactionGuid>
</ClsCloudDocument.ClsUploadDocument>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsUploadDocument'.

Response Information

Resource Description

Uploads a new Cloud Document.

AgvCloudStorageDocument
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<AgvCloudStorageDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Document">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvCloudStorageDocument>