| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<DepartmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Department>
<Active>false</Active>
<ApprovalOn>false</ApprovalOn>
<BillingContact>String</BillingContact>
<BillingEmail>String</BillingEmail>
<BillingMethod>String</BillingMethod>
<Budget>0</Budget>
<Code>String</Code>
<Color>String</Color>
<CostCenter>String</CostCenter>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<DepartmentID>0</DepartmentID>
<DepartmentUID>00000000-0000-0000-0000-000000000000</DepartmentUID>
<Description>String</Description>
<Members>0</Members>
<Name>String</Name>
<Threshold>0</Threshold>
</Department>
<DepartmentID>0</DepartmentID>
</DepartmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DepartmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Department>
<Department>
<Active>false</Active>
<ApprovalOn>false</ApprovalOn>
<BillingContact>String</BillingContact>
<BillingEmail>String</BillingEmail>
<BillingMethod>String</BillingMethod>
<Budget>0</Budget>
<Code>String</Code>
<Color>String</Color>
<CostCenter>String</CostCenter>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<DepartmentID>0</DepartmentID>
<DepartmentUID>00000000-0000-0000-0000-000000000000</DepartmentUID>
<Description>String</Description>
<Members>0</Members>
<Name>String</Name>
<Threshold>0</Threshold>
</Department>
</Department>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</DepartmentResponse>