POST api/ConsigneeCreation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserCredential	UserCredential	None.
ClientDetails	ClientDetails	None.
VersionDetails	VersionDetails	None.
ConsigneeDetails	Address	None.

Request Formats

application/json, text/json

Sample:

{
  "UserCredential": {
    "UserKey": "sample string 1",
    "UserPassword": "sample string 2",
    "UserPIN": "sample string 3"
  },
  "ClientDetails": {
    "AccountNumber": "sample string 1"
  },
  "VersionDetails": {
    "RequestType": "sample string 1",
    "VersionMinor": 2,
    "VersionMajor": 3
  },
  "ConsigneeDetails": {
    "CompanyName": "sample string 1",
    "ContactName": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "AddressLine3": "sample string 5",
    "AddressLine4": "sample string 6",
    "PINorPOBox": "sample string 7",
    "TelephoneNumber": "sample string 8",
    "TelephoneExtension": "sample string 9",
    "MobileNumber": "sample string 10",
    "FaxNumber": "sample string 11",
    "TelexNumber": "sample string 12",
    "Email": "sample string 13",
    "City": "sample string 14",
    "State": "sample string 15",
    "Country": "sample string 16"
  }
}

application/xml, text/xml

Sample:

<ConsgineeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ClientDetails>
    <AccountNumber>sample string 1</AccountNumber>
  </ClientDetails>
  <ConsigneeDetails>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <AddressLine3>sample string 5</AddressLine3>
    <AddressLine4>sample string 6</AddressLine4>
    <City>sample string 14</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <Country>sample string 16</Country>
    <Email>sample string 13</Email>
    <FaxNumber>sample string 11</FaxNumber>
    <MobileNumber>sample string 10</MobileNumber>
    <PINorPOBox>sample string 7</PINorPOBox>
    <State>sample string 15</State>
    <TelephoneExtension>sample string 9</TelephoneExtension>
    <TelephoneNumber>sample string 8</TelephoneNumber>
    <TelexNumber>sample string 12</TelexNumber>
  </ConsigneeDetails>
  <UserCredential>
    <UserKey>sample string 1</UserKey>
    <UserPIN>sample string 3</UserPIN>
    <UserPassword>sample string 2</UserPassword>
  </UserCredential>
  <VersionDetails>
    <RequestType>sample string 1</RequestType>
    <VersionMajor>3</VersionMajor>
    <VersionMinor>2</VersionMinor>
  </VersionDetails>
</ConsgineeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ConsgineeResponse

Name	Description	Type	Additional information
ResponseStatus		ResponseStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseStatus": {
    "Status": "sample string 1",
    "StatusDetails": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ConsgineeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ResponseStatus>
    <Status>sample string 1</Status>
    <StatusDetails>sample string 2</StatusDetails>
  </ResponseStatus>
</ConsgineeResponse>