By providing a specific date, the API provides the description of the corresponding day type.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth node).
- An explicit Logout call (→ Logout).
Request Endpoint
Request
GET https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-wsi/calendar/getDayTypeDescription?day=<YYYYMMDD>Request resource
Not applicable.
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
day |
YES |
String parameter to filter the day type. The string must be formatted according to the pattern YYYYMMDD. |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
|
500 Internal server error |
Endpoint instance is not found. |
Response content-type
JSON
Response output
JSON object that contains the details about the day type.
{"idno": <integer>,"name": <string>}|
JSON field |
Description |
|---|---|
|
idno |
Integer value. It contains the day type identifier. |
|
name |
String value. It contains the day type name. |
Response example: day type description
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-wsi/calendar/getDayTypeDescription?day=20190818Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response output
{"idno": 6,"name": "EDOM"}