Trendsic Platform Service

<back to all web services

AgreementTasksRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/agreement/{AgreementID}/tasks
"use strict";
export class AgreementTask {
    /** @param {{AgreementTaskID?:number,AgreementID?:number,ServiceTaskID?:number,SortOrder?:number,Name?:string,Category?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementTaskID;
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    ServiceTaskID;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    Name;
    /** @type {string} */
    Category;
    /** @type {boolean} */
    Active;
}
export class AgreementTasksResponse {
    /** @param {{Tasks?:AgreementTask[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgreementTask[]} */
    Tasks = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AgreementTasksRequest {
    /** @param {{AgreementID?:number,ServiceTaskIds?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {number[]} */
    ServiceTaskIds = [];
}

JavaScript AgreementTasksRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/agreement/{AgreementID}/tasks HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgreementTasksRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementID>0</AgreementID>
  <ServiceTaskIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ServiceTaskIds>
</AgreementTasksRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementTasksResponse 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>
  <Tasks>
    <AgreementTask>
      <Active>false</Active>
      <AgreementID>0</AgreementID>
      <AgreementTaskID>0</AgreementTaskID>
      <Category>String</Category>
      <Name>String</Name>
      <ServiceTaskID>0</ServiceTaskID>
      <SortOrder>0</SortOrder>
    </AgreementTask>
  </Tasks>
</AgreementTasksResponse>