POST api/WestcorTMPOrder/OpenXOrder

Creates an Order in the TMP system.

Request Information

Parameters

NameDescriptionAdditional information
request
A WestcorOpenOrderRequest 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
  },
  "ClientID": "sample string 1",
  "BusinessID": 2,
  "VendorOrderID": "sample string 3",
  "ClientOrderID": "sample string 4",
  "PriorFile": "sample string 5",
  "Product": "sample string 6",
  "PIDecision": "sample string 7",
  "GIDecision": "sample string 8",
  "Buyers": [
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    },
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    },
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    }
  ],
  "Sellers": [
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    },
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    },
    {
      "Index": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "OrganizationName": "sample string 4",
      "X1Decision": "sample string 5"
    }
  ],
  "Address": "sample string 9",
  "Unit": "sample string 10",
  "City": "sample string 11",
  "CountyFIPS": "sample string 12",
  "StateFIPS": "sample string 13",
  "County": "sample string 14",
  "State": "sample string 15",
  "ZipCode": "sample string 16",
  "DateNeeded": "sample string 17",
  "OptionalProvidedDocuments": [
    {
      "ProvidedDocumentName": "sample string 1",
      "ProvidedDocumentBase64Encoded": "sample string 2"
    },
    {
      "ProvidedDocumentName": "sample string 1",
      "ProvidedDocumentBase64Encoded": "sample string 2"
    },
    {
      "ProvidedDocumentName": "sample string 1",
      "ProvidedDocumentBase64Encoded": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<WestcorOpenXOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <Address>sample string 9</Address>
  <BusinessID>2</BusinessID>
  <Buyers>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
  </Buyers>
  <City>sample string 11</City>
  <ClientID>sample string 1</ClientID>
  <ClientOrderID>sample string 4</ClientOrderID>
  <County>sample string 14</County>
  <CountyFIPS>sample string 12</CountyFIPS>
  <DateNeeded>sample string 17</DateNeeded>
  <GIDecision>sample string 8</GIDecision>
  <Login>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
    <_x003C_SerializeSensitiveInfo_x003E_k__BackingField>true</_x003C_SerializeSensitiveInfo_x003E_k__BackingField>
  </Login>
  <OptionalProvidedDocuments>
    <ProvidedDocument>
      <ProvidedDocumentBase64Encoded>sample string 2</ProvidedDocumentBase64Encoded>
      <ProvidedDocumentName>sample string 1</ProvidedDocumentName>
      <SerializeEncodedDoc>true</SerializeEncodedDoc>
    </ProvidedDocument>
    <ProvidedDocument>
      <ProvidedDocumentBase64Encoded>sample string 2</ProvidedDocumentBase64Encoded>
      <ProvidedDocumentName>sample string 1</ProvidedDocumentName>
      <SerializeEncodedDoc>true</SerializeEncodedDoc>
    </ProvidedDocument>
    <ProvidedDocument>
      <ProvidedDocumentBase64Encoded>sample string 2</ProvidedDocumentBase64Encoded>
      <ProvidedDocumentName>sample string 1</ProvidedDocumentName>
      <SerializeEncodedDoc>true</SerializeEncodedDoc>
    </ProvidedDocument>
  </OptionalProvidedDocuments>
  <PIDecision>sample string 7</PIDecision>
  <PriorFile>sample string 5</PriorFile>
  <Product>sample string 6</Product>
  <Sellers>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
    <BuyerSeller>
      <FirstName>sample string 1</FirstName>
      <Index>1</Index>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <OrganizationName>sample string 4</OrganizationName>
      <X1Decision>sample string 5</X1Decision>
    </BuyerSeller>
  </Sellers>
  <State>sample string 15</State>
  <StateFIPS>sample string 13</StateFIPS>
  <Unit>sample string 10</Unit>
  <VendorOrderID>sample string 3</VendorOrderID>
  <ZipCode>sample string 16</ZipCode>
</WestcorOpenXOrderRequest>

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"
  },
  "TmpFileId": "sample string 1"
}

application/xml, text/xml

Sample:
<WestcorOpenXOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Hub">
  <ResponseInfo>
    <Code>1</Code>
    <Message>sample string 2</Message>
  </ResponseInfo>
  <TmpFileId>sample string 1</TmpFileId>
</WestcorOpenXOrderResponse>