| Requires any of the roles: | Worker, Agent, Administrator, Administrator, Administrator, Administrator |
| GET,POST,PUT,OPTIONS | /v1/Department | ||
|---|---|---|---|
| GET,DELETE,OPTIONS | /v1/Department/{DepartmentID} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DepartmentID | path | int | No | |
| Department | body | Department | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DepartmentID | form | int | No | |
| DepartmentUID | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Code | form | string | No | |
| Color | form | string | No | |
| Budget | form | decimal | No | |
| BillingMethod | form | string | No | |
| CostCenter | form | string | No | |
| BillingContact | form | string | No | |
| BillingEmail | form | string | No | |
| ApprovalOn | form | bool | No | |
| Threshold | form | decimal | No | |
| Active | form | bool | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime | No | |
| Members | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Department | form | List<Department> | 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/Department HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
DepartmentID: 0,
Department:
{
DepartmentID: 0,
DepartmentUID: 00000000000000000000000000000000,
Name: String,
Description: String,
Code: String,
Color: String,
Budget: 0,
BillingMethod: String,
CostCenter: String,
BillingContact: String,
BillingEmail: String,
ApprovalOn: False,
Threshold: 0,
Active: False,
CreatedBy: String,
CreatedAt: 0001-01-01,
Members: 0
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Department:
[
{
DepartmentID: 0,
DepartmentUID: 00000000000000000000000000000000,
Name: String,
Description: String,
Code: String,
Color: String,
Budget: 0,
BillingMethod: String,
CostCenter: String,
BillingContact: String,
BillingEmail: String,
ApprovalOn: False,
Threshold: 0,
Active: False,
CreatedBy: String,
CreatedAt: 0001-01-01,
Members: 0
}
]
}