Bombshell Agency Platform Service

TPADocumentRequest

The following routes are available for this service:
GET,PUT,DELETE,OPTIONS	/v1/TPADocument/{DocumentUID}

To override the Content-type in your clients 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 /xml/reply/TPADocumentRequest HTTP/1.1 
Host: api3.appreciationfinancial.com 
Content-Type: application/xml
Content-Length: length

<TPADocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <DocumentUID>00000000-0000-0000-0000-000000000000</DocumentUID>
  <TPADocument>
    <Slot_TPADocument>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <DocumentUID>00000000-0000-0000-0000-000000000000</DocumentUID>
      <FileName>String</FileName>
      <FilePath>String</FilePath>
      <FileSizeInKB>0</FileSizeInKB>
      <ID>0</ID>
      <TPAID>0</TPAID>
      <TPAName>String</TPAName>
      <TPAType>String</TPAType>
      <TPATypeID>0</TPATypeID>
    </Slot_TPADocument>
  </TPADocument>
</TPADocumentRequest>

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

<AttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <Attachment>
    <Attachment>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
  <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:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</AttachmentResponse>