POST api/Reference/Create
Request Information
URI Parameters
None.
Body Parameters
CreateShipmentReferenceParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| ShipmentGUID | string |
None. |
|
| ReferenceTypeID | integer |
None. |
|
| Value | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"ShipmentGUID": "sample string 2",
"ReferenceTypeID": 3,
"Value": "sample string 4"
}
application/xml, text/xml
Sample:
<CreateShipmentReferenceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ReferenceTypeID>3</ReferenceTypeID> <ShipmentGUID>sample string 2</ShipmentGUID> <Value>sample string 4</Value> <auth>sample string 1</auth> </CreateShipmentReferenceParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>