GET Explicit Options
Overview
The following table contains information about the GET
method for managing the process of retrieving values of explicit options.
GET Explicit Options | |
---|---|
Method | GET |
URL or Endpoint | /api/v1/explicit-options/select-list |
Parameters | Not applicable |
Body | Not applicable |
This method does not include parameters and request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"name": "True",
"value": "true",
"description": null
},
{
"id": 2,
"name": "False",
"value": "false",
"description": null
}
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
errors | array[string] | Indicates if there was an error. |
messages | array[string] | Returns the response message from the backend. |
result | array[object] | Returns the response object containing the detailed result. |
id | integer | The unique identifier for the option. |
name | string | The name of the option. |
value | string | The value of the option. |
description | string | A description of the option |
resultInfo | object | Additional information about the result |
statusCode | integer | The HTTP status code of the response. |
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed