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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class WorkerCrew
            Public Overridable Property CrewID As Integer
            Public Overridable Property CrewName As String
            Public Overridable Property IsManager As Boolean
        End Class

        Public Partial Class WorkerCrewMessage
            Public Overridable Property CrewMessageID As Integer
            Public Overridable Property CrewID As Integer
            Public Overridable Property CrewName As String
            Public Overridable Property SenderContactID As Integer
            Public Overridable Property SenderName As String
            Public Overridable Property Body As String
            Public Overridable Property IsAlert As Boolean
            Public Overridable Property CreatedAtLabel As String
            Public Overridable Property Mine As Boolean
        End Class

        Public Partial Class WorkerMessagesRequest
            Public Overridable Property CrewID As Integer
            Public Overridable Property Body As String
            Public Overridable Property IsAlert As Boolean
        End Class

        Public Partial Class WorkerMessagesResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Crews As List(Of WorkerCrew) = New List(Of WorkerCrew)
            Public Overridable Property Messages As List(Of WorkerCrewMessage) = New List(Of WorkerCrewMessage)
            Public Overridable Property Sent As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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>