| Required roles: | Administrator, Administrator, Administrator | Requires any of the roles: | Agent, Administrator |
| 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;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<LineMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineMessages>
<LineMessage>
<DisplayOrder>0</DisplayOrder>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineName>String</LineName>
<Message>String</Message>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
</LineMessage>
</LineMessages>
</LineMessagesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<LineMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<LineMessages>
<LineMessage>
<DisplayOrder>0</DisplayOrder>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineName>String</LineName>
<Message>String</Message>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
</LineMessage>
</LineMessages>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</LineMessagesResponse>