POST api/WestcorTMPOrder/GetDocument

Get the Document from a Document Order in the TMP system.

Request Information

Parameters

NameDescriptionAdditional information
request
A WestcorGetDocumentRequest object.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Login": {
    "Username": "sample string 1",
    "Password": "sample string 2",
    "<SerializeSensitiveInfo>k__BackingField": true
  },
  "VendorOrderID": "sample string 1",
  "TmpFileId": 2,
  "DocumentAvailableId": 3
}

application/xml, text/xml

Sample:
<WestcorGetDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <DocumentAvailableId>3</DocumentAvailableId>
  <Login>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
    <_x003C_SerializeSensitiveInfo_x003E_k__BackingField>true</_x003C_SerializeSensitiveInfo_x003E_k__BackingField>
  </Login>
  <TmpFileId>2</TmpFileId>
  <VendorOrderID>sample string 1</VendorOrderID>
</WestcorGetDocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "ResponseInfo": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "DocumentName": "sample string 1",
  "DocumentType": "sample string 2",
  "DocumentURL": "sample string 3",
  "DocumentID": 4
}

application/xml, text/xml

Sample:
<WestcorGetDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <DocumentID>4</DocumentID>
  <DocumentName>sample string 1</DocumentName>
  <DocumentType>sample string 2</DocumentType>
  <DocumentURL>sample string 3</DocumentURL>
  <ResponseInfo>
    <Code>1</Code>
    <Message>sample string 2</Message>
  </ResponseInfo>
</WestcorGetDocumentResponse>