GET api/branch

Get all branches.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/branch. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of all branches.

Collection of BranchDto

Name	Description	Type	Additional information
BranchID	Branch Id.	integer
Active	Indicates the branch is acive or not.	boolean
Code	Code.	string
Description	Long Description.	string
Name	Name.	string
BackOfficeGL	Indicates access of other branches GL accounts.	boolean	If true, the user of this branch can access GL accounts of other branches.

Response Formats

application/json, text/json

Sample:

[
  {
    "branchID": 1,
    "active": true,
    "code": "sample string 1",
    "description": "sample string 2",
    "name": "sample string 3",
    "backOfficeGL": true
  },
  {
    "branchID": 1,
    "active": true,
    "code": "sample string 1",
    "description": "sample string 2",
    "name": "sample string 3",
    "backOfficeGL": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfBranchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <BranchDto>
    <Active>true</Active>
    <BackOfficeGL>true</BackOfficeGL>
    <BranchID>1</BranchID>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Name>sample string 3</Name>
  </BranchDto>
  <BranchDto>
    <Active>true</Active>
    <BackOfficeGL>true</BackOfficeGL>
    <BranchID>1</BranchID>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Name>sample string 3</Name>
  </BranchDto>
</ArrayOfBranchDto>