POST
/scheduleCreate Schedule
Implementation Notes
This endpoint allows you to create custom schedules for executing rate shops at specified dates and times.POST
/scheduleParameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | Optional | none | |
» schedulename | body | string | Optional | none |
» rateshopid | body | number | Optional | none |
» year | body | string | Optional | none |
» month | body | string | Optional | none |
» dow | body | string | Optional | none |
» day | body | string | Optional | none |
» hour | body | string | Optional | none |
» minute | body | string | Optional | none |
» seconds | body | string | Optional | none |
» status | body | number | Optional | none |
» startdate | body | string(date) | Optional | none |
» enddate | body | string(date) | Optional | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authentication Failed or Account validity expired | None |
| 500 | Internal Server Error | Internal server error | None |
Example Request
# You can also use wget
curl -X POST /schedule \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses
200 Response
{
"scheduleid": 0,
"schedulename": "string",
"rateshopid": 0,
"year": "string",
"month": "string",
"dow": "string",
"day": "string",
"hour": "string",
"minute": "string",
"seconds": "string",
"status": 0,
"startdate": "2019-08-24",
"enddate": "2019-08-24"
}Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.