| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /customers/{customerId}/inherited-schedule | ||
|---|---|---|---|
| GET | /endpoints/{endpointId}/inherited-schedule |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | string | No | The customer ID whose inherited schedule you want to retrieve |
| EndpointId | path | string | No | The endpoint ID whose inherited schedule you want to retrieve (use this OR customer id |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TimeZoneId | form | string | No | |
| Inherit | form | bool | No | |
| ForceClosed | form | bool | No | |
| Rules | form | List<SchedulingRule> | No | |
| DefaultState | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Priority | form | int | No | |
| State | form | string | No | |
| Source | form | string | No | |
| Condition | form | string | No | |
| SimpleRuleType | form | SimpleSchedulingRuleTypes | No | |
| CustomerState | form | string | No | |
| FlowId | form | string | No | |
| FlowParams | form | Struct | No | |
| IsAllDay | form | bool | No | |
| StartDate | form | string | No | |
| StartTime | form | string | No | |
| EndTime | form | string | No | |
| BySetPosition | form | List<int> | No | |
| ByMonth | form | List<int> | No | |
| ByWeekNo | form | List<int> | No | |
| ByYearDay | form | List<int> | No | |
| ByMonthDay | form | List<int> | No | |
| ByDay | form | List<ScheduleDay> | No | |
| ByHour | form | List<int> | No | |
| ByMinute | form | List<int> | No | |
| Interval | form | int | No | |
| Count | form | int | No | |
| UntilDate | form | string | No | |
| Frequency | form | SchedulingRuleFrequency | No |
| Always | |
| CustomerState | |
| Time |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BoolValue | form | bool? | No | |
| StringValue | form | string | No | |
| NumberValue | form | double? | No | |
| ListValue | form | List<Struct> | No | |
| StructValue | form | Struct | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| DayOfWeek | form | DayOfWeek | No |
| None | |
| Secondly | |
| Minutely | |
| Hourly | |
| Daily | |
| Weekly | |
| Monthly | |
| Yearly |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{customerId}/inherited-schedule HTTP/1.1
Host: evovoice.io
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
timeZoneId: String,
inherit: False,
forceClosed: False,
rules:
[
{
id: String,
name: String,
priority: 0,
state: String,
source: String,
condition: String,
simpleRuleType: Always,
customerState: String,
flowId: String,
isAllDay: False,
startDate: String,
startTime: String,
endTime: String,
bySetPosition:
[
0
],
byMonth:
[
0
],
byWeekNo:
[
0
],
byYearDay:
[
0
],
byMonthDay:
[
0
],
byDay:
[
{
offset: 0,
dayOfWeek: Sunday
}
],
byHour:
[
0
],
byMinute:
[
0
],
interval: 0,
count: 0,
untilDate: String,
frequency: None
}
],
defaultState: String
}