Skip to main content

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
MethodGET
URL or Endpoint/api​/explicit-options/select-list
ParametersNot applicable
BodyNot 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 NameTypeDescription
successboolIf the response is successful, it will return true. Otherwise, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns the response message from the backend.
resultarray[object]Returns the response object containing the detailed result.
idintegerThe unique identifier for the option.
namestringThe name of the option.
valuestringThe value of the option.
descriptionstringA description of the option
resultInfoobjectAdditional information about the result
statusCodeintegerThe 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