Trendsic Platform Service

<back to all web services

WorkerMessagesRequest

Requires Authentication
The following routes are available for this service:
GET,POST,OPTIONS/v1/worker/messages
"use strict";
export class WorkerCrew {
    /** @param {{CrewID?:number,CrewName?:string,IsManager?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewID;
    /** @type {string} */
    CrewName;
    /** @type {boolean} */
    IsManager;
}
export class WorkerCrewMessage {
    /** @param {{CrewMessageID?:number,CrewID?:number,CrewName?:string,SenderContactID?:number,SenderName?:string,Body?:string,IsAlert?:boolean,CreatedAtLabel?:string,Mine?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewMessageID;
    /** @type {number} */
    CrewID;
    /** @type {string} */
    CrewName;
    /** @type {number} */
    SenderContactID;
    /** @type {string} */
    SenderName;
    /** @type {string} */
    Body;
    /** @type {boolean} */
    IsAlert;
    /** @type {string} */
    CreatedAtLabel;
    /** @type {boolean} */
    Mine;
}
export class WorkerMessagesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Crews?:WorkerCrew[],Messages?:WorkerCrewMessage[],Sent?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {WorkerCrew[]} */
    Crews = [];
    /** @type {WorkerCrewMessage[]} */
    Messages = [];
    /** @type {boolean} */
    Sent;
}
export class WorkerMessagesRequest {
    /** @param {{CrewID?:number,Body?:string,IsAlert?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewID;
    /** @type {string} */
    Body;
    /** @type {boolean} */
    IsAlert;
}

JavaScript WorkerMessagesRequest 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.

POST /v1/worker/messages HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WorkerMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Body>String</Body>
  <CrewID>0</CrewID>
  <IsAlert>false</IsAlert>
</WorkerMessagesRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkerMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <WorkerCrew>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <IsManager>false</IsManager>
    </WorkerCrew>
  </Crews>
  <Messages>
    <WorkerCrewMessage>
      <Body>String</Body>
      <CreatedAtLabel>String</CreatedAtLabel>
      <CrewID>0</CrewID>
      <CrewMessageID>0</CrewMessageID>
      <CrewName>String</CrewName>
      <IsAlert>false</IsAlert>
      <Mine>false</Mine>
      <SenderContactID>0</SenderContactID>
      <SenderName>String</SenderName>
    </WorkerCrewMessage>
  </Messages>
  <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>
  <Sent>false</Sent>
</WorkerMessagesResponse>