Board Type

GET 
/lookup/board-type

Fetches a list of lookup values for board type.

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
]

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"
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "name": "board type",
    "displayName": "Board Type",
    "options": [
      {
        "id": "70aaade4-f871-4788-8a8d-dea07e6c7787",
        "description": "Advisory Board (School Only)",
        "code": "ADVISB",
        "sortOrder": 0,
        "active": true,
        "value": "Advisory Board (School Only)",
        "title": "Advisory Board (School Only)"
      }
    ]
  }
}

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...