GET api/deliveryarea/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

DeliveryArea

Name	Type	Additional information
ID	integer	None.
Name	string	None.
Codename	string	None.
SortOrder	integer	None.
Active	boolean	None.
IsDefault	boolean	None.
BoxOrderMargin	decimal number	None.
BoxOrderTolerance	decimal number	None.
FishboxMargin	decimal number	None.
DefaultCourierID	integer	None.
DefaultCourier	Courier	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "Codename": "sample string 3",
  "SortOrder": 4,
  "Active": true,
  "IsDefault": true,
  "BoxOrderMargin": 1.0,
  "BoxOrderTolerance": 1.0,
  "FishboxMargin": 1.0,
  "DefaultCourierID": 1,
  "DefaultCourier": {
    "ID": 1,
    "TypeID": 2,
    "CourierType": {
      "ID": 1,
      "Name": "sample string 2"
    },
    "Key": 2,
    "Name": "sample string 3",
    "Active": true,
    "IsDefault": true
  }
}

application/xml, text/xml

Sample:

<DeliveryArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Delivery">
  <Active>true</Active>
  <BoxOrderMargin>1</BoxOrderMargin>
  <BoxOrderTolerance>1</BoxOrderTolerance>
  <Codename>sample string 3</Codename>
  <DefaultCourier xmlns:d2p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:CourierType>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:CourierType>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:IsDefault>true</d2p1:IsDefault>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:TypeID>2</d2p1:TypeID>
  </DefaultCourier>
  <DefaultCourierID>1</DefaultCourierID>
  <FishboxMargin>1</FishboxMargin>
  <ID>1</ID>
  <IsDefault>true</IsDefault>
  <Name>sample string 2</Name>
  <SortOrder>4</SortOrder>
</DeliveryArea>