GET api/v1/deliveries/{deliveryId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deliveryId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
DeliveryDetailsName | Description | Type | Additional information |
---|---|---|---|
DeliveryId | globally unique identifier |
None. |
|
FlightInformation | FlightInformation |
None. |
|
RecipientDetails | RecipientDetails |
None. |
|
DeliveryInformation | string |
String length: inclusive between 0 and 250 |
|
AdditionalInformation | string |
String length: inclusive between 0 and 250 |
|
DeliveryItems | Collection of DeliveryItemDetails |
None. |
|
DeliveryNumber | string |
None. |
|
DeliveredOn | date |
None. |
|
IsFurtherProcessed | boolean |
None. |
|
Id | globally unique identifier |
None. |
|
CanUpdateRecord | boolean |
None. |
|
CanDeleteRecord | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "DeliveryId": "93f68d9c-6f6b-4dde-bc50-02ca8daa1a48", "FlightInformation": { "FlightId": "2eba9378-1aea-4a29-9213-cfa5cc70c1d9", "FlightDate": "2023-01-31T04:42:01.337264+01:00", "AircraftImmatriculation": "sample string 3", "FlightTypeName": "sample string 4", "PilotName": "sample string 5", "PilotPersonClubMemberNumber": "sample string 6", "SecondCrewName": "sample string 7" }, "RecipientDetails": { "PersonId": "15a99080-2c83-4e4d-8f70-3f4776862618", "RecipientName": "sample string 1", "Firstname": "sample string 2", "Lastname": "sample string 3", "AddressLine1": "sample string 4", "AddressLine2": "sample string 5", "ZipCode": "sample string 6", "City": "sample string 7", "CountryName": "sample string 8", "PersonClubMemberNumber": "sample string 9" }, "DeliveryInformation": "sample string 2", "AdditionalInformation": "sample string 3", "DeliveryItems": [ { "DeliveryItemId": "cb41ecee-df51-42d8-b4cb-64abcf12350a", "Position": 2, "ArticleNumber": "sample string 3", "ItemText": "sample string 4", "AdditionalInformation": "sample string 5", "Quantity": 6.0, "DiscountInPercent": 7, "UnitType": "sample string 8", "Id": "cb41ecee-df51-42d8-b4cb-64abcf12350a", "CanUpdateRecord": true, "CanDeleteRecord": true }, { "DeliveryItemId": "cb41ecee-df51-42d8-b4cb-64abcf12350a", "Position": 2, "ArticleNumber": "sample string 3", "ItemText": "sample string 4", "AdditionalInformation": "sample string 5", "Quantity": 6.0, "DiscountInPercent": 7, "UnitType": "sample string 8", "Id": "cb41ecee-df51-42d8-b4cb-64abcf12350a", "CanUpdateRecord": true, "CanDeleteRecord": true } ], "DeliveryNumber": "sample string 4", "DeliveredOn": "2023-01-31T04:42:01.337264+01:00", "IsFurtherProcessed": true, "Id": "93f68d9c-6f6b-4dde-bc50-02ca8daa1a48", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"DeliveryId":"93f68d9c-6f6b-4dde-bc50-02ca8daa1a48","FlightInformation":{"FlightId":"2eba9378-1aea-4a29-9213-cfa5cc70c1d9","FlightDate":"2023-01-31T04:42:01.337264+01:00","AircraftImmatriculation":"sample string 3","FlightTypeName":"sample string 4","PilotName":"sample string 5","PilotPersonClubMemberNumber":"sample string 6","SecondCrewName":"sample string 7"},"RecipientDetails":{"PersonId":"15a99080-2c83-4e4d-8f70-3f4776862618","RecipientName":"sample string 1","Firstname":"sample string 2","Lastname":"sample string 3","AddressLine1":"sample string 4","AddressLine2":"sample string 5","ZipCode":"sample string 6","City":"sample string 7","CountryName":"sample string 8","PersonClubMemberNumber":"sample string 9"},"DeliveryInformation":"sample string 2","AdditionalInformation":"sample string 3","DeliveryItems":[{"DeliveryItemId":"cb41ecee-df51-42d8-b4cb-64abcf12350a","Position":2,"ArticleNumber":"sample string 3","ItemText":"sample string 4","AdditionalInformation":"sample string 5","Quantity":6.0,"DiscountInPercent":7,"UnitType":"sample string 8","Id":"cb41ecee-df51-42d8-b4cb-64abcf12350a","CanUpdateRecord":true,"CanDeleteRecord":true},{"DeliveryItemId":"cb41ecee-df51-42d8-b4cb-64abcf12350a","Position":2,"ArticleNumber":"sample string 3","ItemText":"sample string 4","AdditionalInformation":"sample string 5","Quantity":6.0,"DiscountInPercent":7,"UnitType":"sample string 8","Id":"cb41ecee-df51-42d8-b4cb-64abcf12350a","CanUpdateRecord":true,"CanDeleteRecord":true}],"DeliveryNumber":"sample string 4","DeliveredOn":"2023-01-31T04:42:01.337264+01:00","IsFurtherProcessed":true,"Id":"93f68d9c-6f6b-4dde-bc50-02ca8daa1a48","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<DeliveryDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Accounting"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">93f68d9c-6f6b-4dde-bc50-02ca8daa1a48</Id> <AdditionalInformation>sample string 3</AdditionalInformation> <DeliveredOn>2023-01-31T04:42:01.337264+01:00</DeliveredOn> <DeliveryId>93f68d9c-6f6b-4dde-bc50-02ca8daa1a48</DeliveryId> <DeliveryInformation>sample string 2</DeliveryInformation> <DeliveryItems> <DeliveryItemDetails> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">cb41ecee-df51-42d8-b4cb-64abcf12350a</Id> <AdditionalInformation>sample string 5</AdditionalInformation> <ArticleNumber>sample string 3</ArticleNumber> <DeliveryItemId>cb41ecee-df51-42d8-b4cb-64abcf12350a</DeliveryItemId> <DiscountInPercent>7</DiscountInPercent> <ItemText>sample string 4</ItemText> <Position>2</Position> <Quantity>6</Quantity> <UnitType>sample string 8</UnitType> </DeliveryItemDetails> <DeliveryItemDetails> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">cb41ecee-df51-42d8-b4cb-64abcf12350a</Id> <AdditionalInformation>sample string 5</AdditionalInformation> <ArticleNumber>sample string 3</ArticleNumber> <DeliveryItemId>cb41ecee-df51-42d8-b4cb-64abcf12350a</DeliveryItemId> <DiscountInPercent>7</DiscountInPercent> <ItemText>sample string 4</ItemText> <Position>2</Position> <Quantity>6</Quantity> <UnitType>sample string 8</UnitType> </DeliveryItemDetails> </DeliveryItems> <DeliveryNumber>sample string 4</DeliveryNumber> <FlightInformation> <AircraftImmatriculation>sample string 3</AircraftImmatriculation> <FlightDate>2023-01-31T04:42:01.337264+01:00</FlightDate> <FlightId>2eba9378-1aea-4a29-9213-cfa5cc70c1d9</FlightId> <FlightTypeName>sample string 4</FlightTypeName> <PilotName>sample string 5</PilotName> <PilotPersonClubMemberNumber>sample string 6</PilotPersonClubMemberNumber> <SecondCrewName>sample string 7</SecondCrewName> </FlightInformation> <IsFurtherProcessed>true</IsFurtherProcessed> <RecipientDetails> <AddressLine1>sample string 4</AddressLine1> <AddressLine2>sample string 5</AddressLine2> <City>sample string 7</City> <CountryName>sample string 8</CountryName> <Firstname>sample string 2</Firstname> <Lastname>sample string 3</Lastname> <PersonClubMemberNumber>sample string 9</PersonClubMemberNumber> <PersonId>15a99080-2c83-4e4d-8f70-3f4776862618</PersonId> <RecipientName>sample string 1</RecipientName> <ZipCode>sample string 6</ZipCode> </RecipientDetails> </DeliveryDetails>