Trendsic Platform Service

<back to all web services

LineMessagesRequest

Requires Authentication
Required roles:Administrator, Administrator, AdministratorRequires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/LineMessages/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/LineMessages
GET,POST,PUT,DELETE,OPTIONS/v1/LineMessages/Line/{LineId}
GET,POST,PUT,DELETE,OPTIONS/v1/LineMessages/Location/{LocationId}/Customers/{CustomerId}
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 LineMessage:
    id: Optional[str] = None
    line_id: Optional[str] = None
    line_name: Optional[str] = None
    message: Optional[str] = None
    message_id: Optional[str] = None
    display_order: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineMessagesResponse:
    response_status: Optional[ResponseStatus] = None
    line_messages: List[LineMessage] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineMessagesRequest:
    id: Optional[str] = None
    line_id: Optional[str] = None
    line_messages: List[LineMessage] = field(default_factory=list)

Python LineMessagesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/LineMessages/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","LineMessages":[{"Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","LineName":"String","Message":"String","MessageId":"00000000000000000000000000000000","DisplayOrder":0}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"LineMessages":[{"Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","LineName":"String","Message":"String","MessageId":"00000000000000000000000000000000","DisplayOrder":0}]}