| POST,OPTIONS | /v1/dispatch/settings/pattern/sample |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PatternId | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Modules | form | List<DispatchModuleView> | No | |
| Patterns | form | List<DispatchPatternView> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Mode | form | string | No | |
| Allowed | form | bool | No | |
| Enabled | form | bool | No | |
| InFlight | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PatternId | form | string | No | |
| Name | form | string | No | |
| Source | form | string | No | |
| Facility | form | string | No | |
| Unit | form | string | No | |
| HasQuotas | form | bool | No | |
| IsInverted | form | bool | No | |
| LoadLimitMins | form | int | No | |
| TicketSource | form | string | No | |
| PayBasis | form | string | No | |
| IsActive | form | bool | 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.
POST /v1/dispatch/settings/pattern/sample HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
PatternId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Modules:
[
{
Key: String,
Mode: String,
Allowed: False,
Enabled: False,
InFlight: 0
}
],
Patterns:
[
{
PatternId: String,
Name: String,
Source: String,
Facility: String,
Unit: String,
HasQuotas: False,
IsInverted: False,
LoadLimitMins: 0,
TicketSource: String,
PayBasis: String,
IsActive: False
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}