POST api/WestcorTMPOrder/DocumentStatus

Gets the Status of a Document Order in the TMP system.

Request Information

Parameters

Name	Description	Additional information
request	A WestcorDocumentStatusRequest 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
}

application/xml, text/xml

Sample:

<WestcorDocumentStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <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>
</WestcorDocumentStatusRequest>

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"
  },
  "EstimatedETA": "sample string 1",
  "EstimatedETAHours": 2,
  "DocumentsAvailable": [
    {
      "DocumentAvailableId": 1,
      "DocumentID": 2,
      "DocumentName": "sample string 3"
    },
    {
      "DocumentAvailableId": 1,
      "DocumentID": 2,
      "DocumentName": "sample string 3"
    },
    {
      "DocumentAvailableId": 1,
      "DocumentID": 2,
      "DocumentName": "sample string 3"
    }
  ],
  "CancellationFees": [
    {
      "FeeName": "sample string 1",
      "FeeAmount": 2.0
    },
    {
      "FeeName": "sample string 1",
      "FeeAmount": 2.0
    },
    {
      "FeeName": "sample string 1",
      "FeeAmount": 2.0
    }
  ]
}

application/xml, text/xml

Sample:

<WestcorDocumentStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <CancellationFees>
    <CancellationFee>
      <FeeAmount>2</FeeAmount>
      <FeeName>sample string 1</FeeName>
    </CancellationFee>
    <CancellationFee>
      <FeeAmount>2</FeeAmount>
      <FeeName>sample string 1</FeeName>
    </CancellationFee>
    <CancellationFee>
      <FeeAmount>2</FeeAmount>
      <FeeName>sample string 1</FeeName>
    </CancellationFee>
  </CancellationFees>
  <DocumentsAvailable>
    <DocumentAvailable>
      <DocumentAvailableId>1</DocumentAvailableId>
      <DocumentID>2</DocumentID>
      <DocumentName>sample string 3</DocumentName>
    </DocumentAvailable>
    <DocumentAvailable>
      <DocumentAvailableId>1</DocumentAvailableId>
      <DocumentID>2</DocumentID>
      <DocumentName>sample string 3</DocumentName>
    </DocumentAvailable>
    <DocumentAvailable>
      <DocumentAvailableId>1</DocumentAvailableId>
      <DocumentID>2</DocumentID>
      <DocumentName>sample string 3</DocumentName>
    </DocumentAvailable>
  </DocumentsAvailable>
  <EstimatedETA>sample string 1</EstimatedETA>
  <EstimatedETAHours>2</EstimatedETAHours>
  <ResponseInfo>
    <Code>1</Code>
    <Message>sample string 2</Message>
  </ResponseInfo>
</WestcorDocumentStatusResponse>