POST api/Manifest

Request Information

URI Parameters

None.

Body Parameters

ManifestRequest
Name Type Description Additional information
Client string

TransactionId Collection of string

Options Dictionary of string [key] and string [value]

FromAddress Address

Carrier string

Request Formats

application/json, text/json

Sample:
{
  "Client": "sample string 1",
  "TransactionId": [
    "sample string 1",
    "sample string 2"
  ],
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "FromAddress": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "Carrier": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:
<ManifestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.Indicium.Models.Manifest">
  <Carrier>sample string 2</Carrier>
  <Client>sample string 1</Client>
  <FromAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Indicium.Models">
    <d2p1:Address1>sample string 7</d2p1:Address1>
    <d2p1:Address2>sample string 8</d2p1:Address2>
    <d2p1:Address3>sample string 9</d2p1:Address3>
    <d2p1:City>sample string 10</d2p1:City>
    <d2p1:Company>sample string 2</d2p1:Company>
    <d2p1:Country>sample string 13</d2p1:Country>
    <d2p1:Description>sample string 5</d2p1:Description>
    <d2p1:Email>sample string 4</d2p1:Email>
    <d2p1:Id>sample string 6</d2p1:Id>
    <d2p1:IsResidential>true</d2p1:IsResidential>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Option>None</d2p1:Option>
    <d2p1:Phone>sample string 3</d2p1:Phone>
    <d2p1:PostalCode>sample string 12</d2p1:PostalCode>
    <d2p1:StateProvince>sample string 11</d2p1:StateProvince>
  </FromAddress>
  <Options xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Options>
  <TransactionId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </TransactionId>
</ManifestRequest>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.