Address Region

GET 
/lookup/address-region

Fetches a list of lookup values for address region.

Request

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
name stringrequired
displayName stringrequired
options object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder numberrequired
active booleanrequired
value stringrequired
title stringrequired
defaultCountryId uuidrequired
defaultCountryDescription stringrequired
postCodeStart stringnullablerequired
postCodeEnd stringnullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "name": "string",
    "displayName": "string",
    "options": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string",
        "sortOrder": 0,
        "active": true,
        "value": "string",
        "title": "string",
        "defaultCountryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "defaultCountryDescription": "string",
        "postCodeStart": "string",
        "postCodeEnd": "string"
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "name": "address region",
    "displayName": "Address Region",
    "options": [
      {
        "id": "d4e8cdf5-90da-4431-8f10-76ae7d3d26cf",
        "description": "Region 1",
        "code": "REGION1",
        "sortOrder": 0,
        "active": true,
        "value": "Region 1",
        "title": "Region 1",
        "defaultCountryId": "283a7817-5c27-48bb-9650-4ccfa11a3704",
        "defaultCountryDescription": "Australia",
        "postCodeStart": "3000",
        "postCodeEnd": "4000"
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...