GET api/culoandistrictcode

Get culoandistrictcodes.

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/culoandistrictcode. 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 list of Loan District Codes.

Collection of CULoanDistrictCodeDto
NameDescriptionTypeAdditional information
CULoanDistrictCodeID

Unique Identifier of the loan district code.

integer Read-Only.
Code

Code of the loan district code.

string
Description

Description of the loan district code.

string
DefaultItem

Indicates wether it is a default loan district code.

boolean

Response Formats

application/json, text/json

Sample:
[
  {
    "cuLoanDistrictCodeID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true
  },
  {
    "cuLoanDistrictCodeID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfCULoanDistrictCodeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CULoanDistrictCodeDto>
    <CULoanDistrictCodeID>1</CULoanDistrictCodeID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
  </CULoanDistrictCodeDto>
  <CULoanDistrictCodeDto>
    <CULoanDistrictCodeID>1</CULoanDistrictCodeID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
  </CULoanDistrictCodeDto>
</ArrayOfCULoanDistrictCodeDto>