| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Broadcast/{BroadcastId} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Broadcast |
<?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 Broadcast implements JsonSerializable
{
public function __construct(
/** @var int */
public int $BroadcastId=0,
/** @var string|null */
public ?string $BroadcastTitle=null,
/** @var string|null */
public ?string $BroadcastDescription=null,
/** @var DateTime */
public DateTime $BroadcastBegin=new DateTime(),
/** @var string|null */
public ?string $BroadcastBeginTime=null,
/** @var DateTime */
public DateTime $BroadcastEnd=new DateTime(),
/** @var string|null */
public ?string $BroadcastEndTime=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BroadcastId'])) $this->BroadcastId = $o['BroadcastId'];
if (isset($o['BroadcastTitle'])) $this->BroadcastTitle = $o['BroadcastTitle'];
if (isset($o['BroadcastDescription'])) $this->BroadcastDescription = $o['BroadcastDescription'];
if (isset($o['BroadcastBegin'])) $this->BroadcastBegin = JsonConverters::from('DateTime', $o['BroadcastBegin']);
if (isset($o['BroadcastBeginTime'])) $this->BroadcastBeginTime = $o['BroadcastBeginTime'];
if (isset($o['BroadcastEnd'])) $this->BroadcastEnd = JsonConverters::from('DateTime', $o['BroadcastEnd']);
if (isset($o['BroadcastEndTime'])) $this->BroadcastEndTime = $o['BroadcastEndTime'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BroadcastId)) $o['BroadcastId'] = $this->BroadcastId;
if (isset($this->BroadcastTitle)) $o['BroadcastTitle'] = $this->BroadcastTitle;
if (isset($this->BroadcastDescription)) $o['BroadcastDescription'] = $this->BroadcastDescription;
if (isset($this->BroadcastBegin)) $o['BroadcastBegin'] = JsonConverters::to('DateTime', $this->BroadcastBegin);
if (isset($this->BroadcastBeginTime)) $o['BroadcastBeginTime'] = $this->BroadcastBeginTime;
if (isset($this->BroadcastEnd)) $o['BroadcastEnd'] = JsonConverters::to('DateTime', $this->BroadcastEnd);
if (isset($this->BroadcastEndTime)) $o['BroadcastEndTime'] = $this->BroadcastEndTime;
return empty($o) ? new class(){} : $o;
}
}
class BroadcastResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<Broadcast>|null */
public ?array $Broadcast=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Broadcast'])) $this->Broadcast = JsonConverters::fromArray('Broadcast', $o['Broadcast']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Broadcast)) $o['Broadcast'] = JsonConverters::toArray('Broadcast', $this->Broadcast);
return empty($o) ? new class(){} : $o;
}
}
class BroadcastRequest implements JsonSerializable
{
public function __construct(
/** @var array<Broadcast>|null */
public ?array $Broadcast=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Broadcast'])) $this->Broadcast = JsonConverters::fromArray('Broadcast', $o['Broadcast']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Broadcast)) $o['Broadcast'] = JsonConverters::toArray('Broadcast', $this->Broadcast);
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.
GET /v1/Broadcast/{BroadcastId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BroadcastResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Broadcast>
<Broadcast>
<BroadcastBegin>0001-01-01T00:00:00</BroadcastBegin>
<BroadcastBeginTime>String</BroadcastBeginTime>
<BroadcastDescription>String</BroadcastDescription>
<BroadcastEnd>0001-01-01T00:00:00</BroadcastEnd>
<BroadcastEndTime>String</BroadcastEndTime>
<BroadcastId>0</BroadcastId>
<BroadcastTitle>String</BroadcastTitle>
</Broadcast>
</Broadcast>
<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>
</BroadcastResponse>