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