Jump to

• Request
• Response

Gets all the branches to which user has access to

get

/service/v1/branchAccess

This endpoint is used to get all the branches to which user has access to.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application Id
• branchCode: string
  branchCode
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns list of accessible branches for the user

Body ()

Root Schema : UserBranchAccessDTO

Type: object

Show Source

• allowedBranches(optional): array allowedBranches
• hasAccessToAllBranches(optional): string
  Flag to state if the user has access to all the branches in the application

{
    "type":"object",
    "properties":{
        "hasAccessToAllBranches":{
            "description":"Flag to state if the user has access to all the branches in the application",
            "type":"string"
        },
        "allowedBranches":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BranchDTO"
            }
        }
    }
}

Nested Schema : allowedBranches

Type: array

Show Source

• Array of: object BranchDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BranchDTO"
    }
}

Nested Schema : BranchDTO

Type: object

Show Source

• branchCode(optional): string
  Branch Code
• branchName(optional): string
  Branch Name

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchName":{
            "type":"string",
            "description":"Branch Name"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top