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
ServiceResultOfParcelDetailsModel| Name | 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": "c688c3c4-8b8d-4b5c-a65b-18f265f5ac80",
"InsuranceLevel": null,
"CollectionAddress": "sample string 10",
"CollectionZipCode": "sample string 11",
"CollectionPhone": "sample string 12",
"CollectionName": "sample string 13",
"CollectionCity": "sample string 14",
"CollectionCountry": "689d322d-dec0-4cdb-8120-bd5c7438024e",
"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": "1f735a61-0f80-4326-95ef-f686229821bf",
"DestinationCountryDisplay": "sample string 24",
"Packages": [
{
"Id": "dae28b15-af1d-4b3a-aaf4-88bc06bc1d54",
"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": "9c88b11f-5679-4cbd-90c1-d98011f39870",
"ExternalOperator": "sample string 10",
"ExternalCode": 1
},
{
"Id": "dae28b15-af1d-4b3a-aaf4-88bc06bc1d54",
"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": "9c88b11f-5679-4cbd-90c1-d98011f39870",
"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.