| GET,OPTIONS | /v1/Scheduler/Settings/{LocationId}/{AgentId}/{Mode} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationId | path | Guid | No | |
| AgentId | path | int | No | |
| Mode | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfigId | form | int | No | |
| SchedulerUrl | form | string | No | |
| SchedulerName | form | string | No | |
| DefaultLocation | form | string | No | |
| DefaultSummary | form | string | No | |
| DefaultDescription | form | string | No | |
| DayStart | form | TimeSpan | No | |
| DayStartFriendly | form | string | No | |
| DayEnd | form | TimeSpan | No | |
| DayEndFriendly | form | string | No | |
| TimeslotDuration | form | int | No | |
| NumberOfSlots | form | int? | No | |
| LocationId | form | Guid | No | |
| CalendarId | form | Guid | No | |
| AgentId | form | int | No | |
| TimeZone | form | string | No | |
| AvailableDateTimes | form | List<ScheduleConfigDay> | No | |
| AvailableServices | form | List<Guid> | No | |
| AllServices | form | List<Line> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayName | form | string | No | |
| DayNumber | form | int? | No | |
| DayEnabled | form | bool? | No | |
| TimeBlocks | form | List<ScheduleConfigTimeBlock> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartTime | form | TimeSpan | No | |
| DayStartFriendly | form | string | No | |
| EndTime | form | TimeSpan | No | |
| DayEndFriendly | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| LocationId | form | Guid | No | |
| LocationName | form | string | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| ServiceDurationMinutes | form | int | No | |
| WaitTime | form | int | No | |
| Cost | form | decimal | No | |
| UpperThreshold | form | int? | No | |
| LowerThreshold | form | int? | No | |
| Active | form | bool | No | |
| EntDate | form | DateTime? | No | |
| ModDate | form | DateTime? | No | |
| SendQuestionnaire | form | bool | No | |
| RequireUpload | form | bool | No | |
| UploadMessage | form | string | No | |
| LineImages | form | List<LineImage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ImageId | form | Guid? | No | |
| FileName | form | string | No | |
| ImageTitle | form | string | No | |
| UploadDate | form | DateTime | No |
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 /v1/Scheduler/Settings/{LocationId}/{AgentId}/{Mode} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ConfigId: 0,
SchedulerUrl: String,
SchedulerName: String,
DefaultLocation: String,
DefaultSummary: String,
DefaultDescription: String,
DayStart: PT0S,
DayStartFriendly: "00:00",
DayEnd: PT0S,
DayEndFriendly: "00:00",
TimeslotDuration: 0,
NumberOfSlots: 0,
LocationId: 00000000000000000000000000000000,
CalendarId: 00000000000000000000000000000000,
AgentId: 0,
TimeZone: String,
AvailableDateTimes:
[
{
DayName: String,
DayNumber: 0,
DayEnabled: False,
TimeBlocks:
[
{
StartTime: PT0S,
DayStartFriendly: "00:00",
EndTime: PT0S,
DayEndFriendly: "00:00"
}
]
}
],
AvailableServices:
[
00000000000000000000000000000000
],
AllServices:
[
{
Id: 00000000000000000000000000000000,
LocationId: 00000000000000000000000000000000,
LocationName: String,
Name: String,
Description: String,
ServiceDurationMinutes: 0,
WaitTime: 0,
Cost: 0,
UpperThreshold: 0,
LowerThreshold: 0,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01,
SendQuestionnaire: False,
RequireUpload: False,
UploadMessage: String,
LineImages:
[
{
ImageId: 00000000000000000000000000000000,
FileName: String,
ImageTitle: String,
UploadDate: 0001-01-01
}
]
}
]
}