GET api/v1/Setup/GetBranchesByPostlCode?companyId={companyId}&postalCode={postalCode}

Home / API / ASP.NET Web API Details

GET api/v1/Setup/GetBranchesByPostlCode?companyId={companyId}&postalCode={postalCode}

Description

Get List Of All Branches by Postal Code

Request Information

Parameters

Name	Description	Additional information
companyId		Define this parameter in the request URI.
postalCode		Define this parameter in the request URI.

Response Information

List of Branches

Response body formats

application/json, text/json

Sample:

[
  {
    "BranchId": 1,
    "CompanyId": 2,
    "BranchName": "sample string 3",
    "CompanyName": "sample string 4",
    "DistrictName": "sample string 5",
    "RegionName": "sample string 6",
    "ContactId": 7,
    "StreetAddressId": 8
  },
  {
    "BranchId": 1,
    "CompanyId": 2,
    "BranchName": "sample string 3",
    "CompanyName": "sample string 4",
    "DistrictName": "sample string 5",
    "RegionName": "sample string 6",
    "ContactId": 7,
    "StreetAddressId": 8
  }
]

application/xml, text/xml

Sample:

<ArrayOfBranchDetailsLite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <BranchDetailsLite>
    <BranchId>1</BranchId>
    <BranchName>sample string 3</BranchName>
    <CompanyId>2</CompanyId>
    <CompanyName>sample string 4</CompanyName>
    <ContactId>7</ContactId>
    <DistrictName>sample string 5</DistrictName>
    <RegionName>sample string 6</RegionName>
    <StreetAddressId>8</StreetAddressId>
  </BranchDetailsLite>
  <BranchDetailsLite>
    <BranchId>1</BranchId>
    <BranchName>sample string 3</BranchName>
    <CompanyId>2</CompanyId>
    <CompanyName>sample string 4</CompanyName>
    <ContactId>7</ContactId>
    <DistrictName>sample string 5</DistrictName>
    <RegionName>sample string 6</RegionName>
    <StreetAddressId>8</StreetAddressId>
  </BranchDetailsLite>
</ArrayOfBranchDetailsLite>