Get branch

GET 
/Branches/:branchCode

Get branch

Request

Path Parameters

branchCode stringrequired

The branch code.

Responses

200

The branch with the specified branch code.

application/json

Schema

Schema

branchCode stringnullablerequired

The unique code identifying the branch.

branchTitle stringnullablerequired

The display title of the branch.

branchAddress stringnullablerequired

The street address of the branch.

branchPostCode stringnullablerequired

The postal code of the branch location.

branchCityName stringnullablerequired

The city where the branch is located.

branchProvinceName stringnullablerequired

The province or region where the branch is located.

branchCountryCode stringnullablerequired

The ISO country code where the branch is located.

createInfo object

Audit metadata capturing who created this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

updateInfo object

Audit metadata capturing who last updated this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

Example (from schema)

{
  "branchCode": "string",
  "branchTitle": "string",
  "branchAddress": "string",
  "branchPostCode": "string",
  "branchCityName": "string",
  "branchProvinceName": "string",
  "branchCountryCode": "string",
  "createInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  },
  "updateInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  }
}

304

The branch has not changed since the date given in the If-Modified-Since HTTP header.

404

A branch with the specified branch code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...