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

export class WorkerCrew
{
    public CrewID: number;
    public CrewName: string;
    public IsManager: boolean;

    public constructor(init?: Partial<WorkerCrew>) { (Object as any).assign(this, init); }
}

export class WorkerCrewMessage
{
    public CrewMessageID: number;
    public CrewID: number;
    public CrewName: string;
    public SenderContactID: number;
    public SenderName: string;
    public Body: string;
    public IsAlert: boolean;
    public CreatedAtLabel: string;
    public Mine: boolean;

    public constructor(init?: Partial<WorkerCrewMessage>) { (Object as any).assign(this, init); }
}

export class WorkerMessagesResponse
{
    public ResponseStatus: ResponseStatus;
    public Crews: WorkerCrew[] = [];
    public Messages: WorkerCrewMessage[] = [];
    public Sent: boolean;

    public constructor(init?: Partial<WorkerMessagesResponse>) { (Object as any).assign(this, init); }
}

export class WorkerMessagesRequest
{
    public CrewID: number;
    public Body: string;
    public IsAlert: boolean;

    public constructor(init?: Partial<WorkerMessagesRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
}