| Requires any of the roles: | Worker, Agent, Administrator, Administrator, Administrator, Administrator |
| GET,POST,PUT,OPTIONS | /v1/Department | ||
|---|---|---|---|
| GET,DELETE,OPTIONS | /v1/Department/{DepartmentID} |
"use strict";
export class Department {
/** @param {{DepartmentID?:number,DepartmentUID?:string,Name?:string,Description?:string,Code?:string,Color?:string,Budget?:number,BillingMethod?:string,CostCenter?:string,BillingContact?:string,BillingEmail?:string,ApprovalOn?:boolean,Threshold?:number,Active?:boolean,CreatedBy?:string,CreatedAt?:string,Members?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DepartmentID;
/** @type {string} */
DepartmentUID;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Code;
/** @type {string} */
Color;
/** @type {number} */
Budget;
/** @type {string} */
BillingMethod;
/** @type {string} */
CostCenter;
/** @type {string} */
BillingContact;
/** @type {string} */
BillingEmail;
/** @type {boolean} */
ApprovalOn;
/** @type {number} */
Threshold;
/** @type {boolean} */
Active;
/** @type {string} */
CreatedBy;
/** @type {string} */
CreatedAt;
/** @type {number} */
Members;
}
export class DepartmentResponse {
/** @param {{ResponseStatus?:ResponseStatus,Department?:Department[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Department[]} */
Department = [];
}
export class DepartmentRequest {
/** @param {{DepartmentID?:number,Department?:Department}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DepartmentID;
/** @type {Department} */
Department;
}
JavaScript DepartmentRequest DTOs
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
}
]
}