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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkerCrew() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val IsManager:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkerCrewMessage() = 
        member val CrewMessageID:Int32 = new Int32() with get,set
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val SenderContactID:Int32 = new Int32() with get,set
        member val SenderName:String = null with get,set
        member val Body:String = null with get,set
        member val IsAlert:Boolean = new Boolean() with get,set
        member val CreatedAtLabel:String = null with get,set
        member val Mine:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkerMessagesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Crews:ResizeArray<WorkerCrew> = new ResizeArray<WorkerCrew>() with get,set
        member val Messages:ResizeArray<WorkerCrewMessage> = new ResizeArray<WorkerCrewMessage>() with get,set
        member val Sent:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkerMessagesRequest() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val Body:String = null with get,set
        member val IsAlert:Boolean = new Boolean() with get,set

F# WorkerMessagesRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CrewID: 0,
	Body: String,
	IsAlert: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Crews: 
	[
		{
			CrewID: 0,
			CrewName: String,
			IsManager: False
		}
	],
	Messages: 
	[
		{
			CrewMessageID: 0,
			CrewID: 0,
			CrewName: String,
			SenderContactID: 0,
			SenderName: String,
			Body: String,
			IsAlert: False,
			CreatedAtLabel: String,
			Mine: False
		}
	],
	Sent: False
}