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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerCrew:
    crew_i_d: int = 0
    crew_name: Optional[str] = None
    is_manager: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerCrewMessage:
    crew_message_i_d: int = 0
    crew_i_d: int = 0
    crew_name: Optional[str] = None
    sender_contact_i_d: int = 0
    sender_name: Optional[str] = None
    body: Optional[str] = None
    is_alert: bool = False
    created_at_label: Optional[str] = None
    mine: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerMessagesResponse:
    response_status: Optional[ResponseStatus] = None
    crews: List[WorkerCrew] = field(default_factory=list)
    messages: List[WorkerCrewMessage] = field(default_factory=list)
    sent: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerMessagesRequest:
    crew_i_d: int = 0
    body: Optional[str] = None
    is_alert: bool = False

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