| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator |
| DELETE,OPTIONS | /v1/Task/{TaskId} | ||
|---|---|---|---|
| GET,POST,PUT,OPTIONS | /v1/Task |
"use strict";
export class Task {
/** @param {{TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToContactId?:number,CreatedBy?:number,DateCreated?:string,DateCompleted?:string,CompletedBy?:number,DateDeleted?:string,DeletedBy?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TaskId;
/** @type {string} */
Description;
/** @type {string} */
DueDate;
/** @type {number} */
AssignedToAgentId;
/** @type {number} */
RelatedToContactId;
/** @type {number} */
CreatedBy;
/** @type {string} */
DateCreated;
/** @type {string} */
DateCompleted;
/** @type {number} */
CompletedBy;
/** @type {string} */
DateDeleted;
/** @type {number} */
DeletedBy;
}
export class TaskExtended extends Task {
/** @param {{AssignedToName?:string,RelatedToName?:string,TaskId?:string,Description?:string,DueDate?:string,AssignedToAgentId?:number,RelatedToContactId?:number,CreatedBy?:number,DateCreated?:string,DateCompleted?:string,CompletedBy?:number,DateDeleted?:string,DeletedBy?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
AssignedToName;
/** @type {string} */
RelatedToName;
}
export class TaskResponse {
/** @param {{ResponseStatus?:ResponseStatus,Task?:TaskExtended[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {TaskExtended[]} */
Task = [];
}
export class TaskRequest {
/** @param {{Task?:TaskExtended,TaskId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TaskExtended} */
Task;
/** @type {string} */
TaskId;
}
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/Task HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TaskRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Task>
<AssignedToAgentId>0</AssignedToAgentId>
<CompletedBy>0</CompletedBy>
<CreatedBy>0</CreatedBy>
<DateCompleted>0001-01-01T00:00:00</DateCompleted>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateDeleted>0001-01-01T00:00:00</DateDeleted>
<DeletedBy>0</DeletedBy>
<Description>String</Description>
<DueDate>0001-01-01T00:00:00</DueDate>
<RelatedToContactId>0</RelatedToContactId>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<AssignedToName>String</AssignedToName>
<RelatedToName>String</RelatedToName>
</Task>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
</TaskRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TaskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Task>
<TaskExtended>
<AssignedToAgentId>0</AssignedToAgentId>
<CompletedBy>0</CompletedBy>
<CreatedBy>0</CreatedBy>
<DateCompleted>0001-01-01T00:00:00</DateCompleted>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateDeleted>0001-01-01T00:00:00</DateDeleted>
<DeletedBy>0</DeletedBy>
<Description>String</Description>
<DueDate>0001-01-01T00:00:00</DueDate>
<RelatedToContactId>0</RelatedToContactId>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<AssignedToName>String</AssignedToName>
<RelatedToName>String</RelatedToName>
</TaskExtended>
</Task>
</TaskResponse>