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
WorkerMessagesRequest Parameters:
NameParameterData TypeRequiredDescription
CrewIDbodyintNo
BodybodystringNo
IsAlertbodyboolNo
WorkerMessagesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CrewsformList<WorkerCrew>No
MessagesformList<WorkerCrewMessage>No
SentformboolNo
WorkerCrew Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
CrewNameformstringNo
IsManagerformboolNo
WorkerCrewMessage Parameters:
NameParameterData TypeRequiredDescription
CrewMessageIDformintNo
CrewIDformintNo
CrewNameformstringNo
SenderContactIDformintNo
SenderNameformstringNo
BodyformstringNo
IsAlertformboolNo
CreatedAtLabelformstringNo
MineformboolNo

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
}