GET api/Parcel/Get?authToken={authToken}&parcelId={parcelId}
Get Specific Parcel by Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The Authentication Token |
string |
Required |
parcelId |
The Parcel Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfParcelDetailsModelName | Description | Type | Additional information |
---|---|---|---|
Result | ParcelDetailsModel |
None. |
|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "Name": "sample string 2", "BidParcelId": "sample string 3", "NumberOfVolumes": 4, "Comments": "sample string 5", "Reference": "sample string 6", "ATCode": "sample string 7", "InsurancesIsActive": true, "InsuranceType": 1, "InsuranceTypeDisplay": "sample string 9", "InsuranceFixedModel": null, "InsuranceLevelId": "13de10ac-a630-4a97-82f0-93dc739e8c53", "InsuranceLevel": null, "CollectionAddress": "sample string 10", "CollectionZipCode": "sample string 11", "CollectionPhone": "sample string 12", "CollectionName": "sample string 13", "CollectionCity": "sample string 14", "CollectionCountry": "62dbb0f2-4fbc-42a4-852a-3a5c2ef91c0b", "CollectionCountryDisplay": "sample string 16", "DestinationName": "sample string 17", "DestinationEmail": "sample string 18", "DestinationPhone": "sample string 19", "DestinationAddress": "sample string 20", "DestinationZipCode": "sample string 21", "DestinationCity": "sample string 22", "DestinationCountry": "7a036406-f9c5-4341-a0d2-ed1dfd602ca1", "DestinationCountryDisplay": "sample string 24", "Packages": [ { "Id": "2e70aaee-0a04-4722-b46c-bbe0684234e9", "PackageNumber": 2, "Name": "sample string 3", "Weight": 4.0, "Height": 5.0, "Width": 6.0, "Length": 7.0, "Quantity": 8, "BidParcelId": "sample string 9", "ExternalOperatorId": "a91b1fbb-cb8e-4f92-8993-86086a63dc53", "ExternalOperator": "sample string 10", "ExternalCode": 1 }, { "Id": "2e70aaee-0a04-4722-b46c-bbe0684234e9", "PackageNumber": 2, "Name": "sample string 3", "Weight": 4.0, "Height": 5.0, "Width": 6.0, "Length": 7.0, "Quantity": 8, "BidParcelId": "sample string 9", "ExternalOperatorId": "a91b1fbb-cb8e-4f92-8993-86086a63dc53", "ExternalOperator": "sample string 10", "ExternalCode": 1 } ] }, "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.