Get Classifications

GET /v1/classifications

Responses

200 application/json

Request succeeded.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique id.
- createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
- modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
- name string Required
  
  The name of the classification.
- code string Required
  
  The code for the classification.
- endCount number(double) Required
  
  The total number of ends or sides this classification represents. This value will be either 0, 1 or 2.
  
  Minimum value is 0, maximum value is 2.
- endTypeCode string Required
  
  The code representing the end type or side for the classification.
  
  Values are B, D, M, S, or X.
- inactiveDate string(date) | null
  
  The date the classification was no longer active.
400 application/json

Invalid request. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
401 application/json

Unauthorized. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
403 application/json

Permission denied. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.

GET /v1/classifications

curl \
 --request GET 'https://api.lwolf.com/backoffice/v1/classifications'

Response examples (200)

[
  {
    "id": "string",
    "code": "string",
    "name": "string",
    "endCount": 0,
    "endTypeCode": "B",
    "inactiveDate": "string",
    "createdTimestamp": "string",
    "modifiedTimestamp": "string"
  }
]

Response examples (400)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (401)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (403)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}