GET api/Branches/{id}

Gets a specific branch by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Remarks

404 Not found is returned if the specified branch cannot be found.

Example

None.

Response Information

Resource Description

BranchResponse
NameDescriptionTypeAdditional information
Id

integer

Required
Name

string

Required

Max length: 80
Address1

string

Max length: 100
Address2

string

Max length: 100
Address3

string

Max length: 100
PostalCode

string

Max length: 10
Town

string

Max length: 50
CountryId

string

Required

Max length: 2
CountryName

string

Max length: 50
Phone1

string

Max length: 50
Phone2

string

Max length: 50
Fax

string

Max length: 50
WebSite

string

Max length: 100
Email

string

Max length: 50
PriceListId

globally unique identifier

None.
PriceListName

string

Max length: 50
IsDeleted

boolean

Required
ZoneId

integer

None.
ZoneName

string

Max length: 96
CentralWarehouse

boolean

Required
DefaultAgreementNumber

integer

None.
DefaultAgreementName

string

Max length: 40
TransportationScheduleId

integer

None.
TransportationScheduleDescription

string

Max length: 50
DeliveryAddress1

string

Max length: 50
DeliveryAddress2

string

Max length: 50
DeliveryAddress3

string

Max length: 50
DeliveryPostalCode

string

Max length: 50
DeliveryTown

string

Max length: 50

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "PostalCode": "sample string 6",
  "Town": "sample string 7",
  "CountryId": "sample string 8",
  "CountryName": "sample string 9",
  "Phone1": "sample string 10",
  "Phone2": "sample string 11",
  "Fax": "sample string 12",
  "WebSite": "sample string 13",
  "Email": "sample string 14",
  "PriceListId": "cf4dd817-d02c-45c8-a8f8-7ac6fd9bae2d",
  "PriceListName": "sample string 15",
  "IsDeleted": true,
  "ZoneId": 1,
  "ZoneName": "sample string 17",
  "CentralWarehouse": true,
  "DefaultAgreementNumber": 1,
  "DefaultAgreementName": "sample string 19",
  "TransportationScheduleId": 1,
  "TransportationScheduleDescription": "sample string 20",
  "DeliveryAddress1": "sample string 21",
  "DeliveryAddress2": "sample string 22",
  "DeliveryAddress3": "sample string 23",
  "DeliveryPostalCode": "sample string 24",
  "DeliveryTown": "sample string 25"
}

application/xml, text/xml

Sample: 
<BranchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <Address3>sample string 5</Address3>
  <CentralWarehouse>true</CentralWarehouse>
  <CountryId>sample string 8</CountryId>
  <CountryName>sample string 9</CountryName>
  <DefaultAgreementName>sample string 19</DefaultAgreementName>
  <DefaultAgreementNumber>1</DefaultAgreementNumber>
  <DeliveryAddress1>sample string 21</DeliveryAddress1>
  <DeliveryAddress2>sample string 22</DeliveryAddress2>
  <DeliveryAddress3>sample string 23</DeliveryAddress3>
  <DeliveryPostalCode>sample string 24</DeliveryPostalCode>
  <DeliveryTown>sample string 25</DeliveryTown>
  <Email>sample string 14</Email>
  <Fax>sample string 12</Fax>
  <Id>1</Id>
  <IsDeleted>true</IsDeleted>
  <Name>sample string 2</Name>
  <Phone1>sample string 10</Phone1>
  <Phone2>sample string 11</Phone2>
  <PostalCode>sample string 6</PostalCode>
  <PriceListId>cf4dd817-d02c-45c8-a8f8-7ac6fd9bae2d</PriceListId>
  <PriceListName>sample string 15</PriceListName>
  <Town>sample string 7</Town>
  <TransportationScheduleDescription>sample string 20</TransportationScheduleDescription>
  <TransportationScheduleId>1</TransportationScheduleId>
  <WebSite>sample string 13</WebSite>
  <ZoneId>1</ZoneId>
  <ZoneName>sample string 17</ZoneName>
</BranchResponse>