Bombshell Agency Platform Service

<back to all web services

PDFDocumentRequest

The following routes are available for this service:
GET,OPTIONS/v1/PDFDocument/{DocumentId}
GET,OPTIONS/v1/PDFDocument/ByCard/{CardId}

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/PDFDocumentRequest HTTP/1.1 
Host: testapi3.teamifg.com 
Content-Type: application/xml
Content-Length: length

<PDFDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <CardId>0</CardId>
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <PDFDocument>
    <PDFDocument>
      <CardId>0</CardId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <PDFDocument>AA==</PDFDocument>
    </PDFDocument>
  </PDFDocument>
</PDFDocumentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PDFDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <PDFDocument>
    <PDFDocument>
      <CardId>0</CardId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <PDFDocument>AA==</PDFDocument>
    </PDFDocument>
  </PDFDocument>
  <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>
</PDFDocumentResponse>