Trendsic Platform Service

LineMessagesRequest

**Requires Authentication**
Required roles:	Administrator, Administrator, Administrator	Requires 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}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class LineMessage implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $LineId='',
        /** @var string|null */
        public ?string $LineName=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string */
        public string $MessageId='',
        /** @var int */
        public int $DisplayOrder=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['LineId'])) $this->LineId = $o['LineId'];
        if (isset($o['LineName'])) $this->LineName = $o['LineName'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['MessageId'])) $this->MessageId = $o['MessageId'];
        if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->LineId)) $o['LineId'] = $this->LineId;
        if (isset($this->LineName)) $o['LineName'] = $this->LineName;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->MessageId)) $o['MessageId'] = $this->MessageId;
        if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
        return empty($o) ? new class(){} : $o;
    }
}

class LineMessagesResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<LineMessage>|null */
        public ?array $LineMessages=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['LineMessages'])) $this->LineMessages = JsonConverters::fromArray('LineMessage', $o['LineMessages']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->LineMessages)) $o['LineMessages'] = JsonConverters::toArray('LineMessage', $this->LineMessages);
        return empty($o) ? new class(){} : $o;
    }
}

class LineMessagesRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $LineId='',
        /** @var array<LineMessage>|null */
        public ?array $LineMessages=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['LineId'])) $this->LineId = $o['LineId'];
        if (isset($o['LineMessages'])) $this->LineMessages = JsonConverters::fromArray('LineMessage', $o['LineMessages']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->LineId)) $o['LineId'] = $this->LineId;
        if (isset($this->LineMessages)) $o['LineMessages'] = JsonConverters::toArray('LineMessage', $this->LineMessages);
        return empty($o) ? new class(){} : $o;
    }
}

PHP LineMessagesRequest 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/LineMessages/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
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: 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
		}
	},
	LineMessages: 
	[
		{
			Id: 00000000000000000000000000000000,
			LineId: 00000000000000000000000000000000,
			LineName: String,
			Message: String,
			MessageId: 00000000000000000000000000000000,
			DisplayOrder: 0
		}
	]
}