| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/PredefinedText/{ID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/PredefinedText | ||
| GET | /v1/PredefinedText/ByType/{Type} |
<?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 PredefinedText implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ID=0,
/** @var string|null */
public ?string $Type=null,
/** @var string|null */
public ?string $Text=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['Text'])) $this->Text = $o['Text'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->Text)) $o['Text'] = $this->Text;
return empty($o) ? new class(){} : $o;
}
}
class PredefinedTextResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<PredefinedText>|null */
public ?array $PredefinedText=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['PredefinedText'])) $this->PredefinedText = JsonConverters::fromArray('PredefinedText', $o['PredefinedText']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->PredefinedText)) $o['PredefinedText'] = JsonConverters::toArray('PredefinedText', $this->PredefinedText);
return empty($o) ? new class(){} : $o;
}
}
class PredefinedTextRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Type=null,
/** @var int */
public int $ID=0,
/** @var array<PredefinedText>|null */
public ?array $PredefinedText=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['ID'])) $this->ID = $o['ID'];
if (isset($o['PredefinedText'])) $this->PredefinedText = JsonConverters::fromArray('PredefinedText', $o['PredefinedText']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->ID)) $o['ID'] = $this->ID;
if (isset($this->PredefinedText)) $o['PredefinedText'] = JsonConverters::toArray('PredefinedText', $this->PredefinedText);
return empty($o) ? new class(){} : $o;
}
}
PHP PredefinedTextRequest DTOs
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/PredefinedText/{ID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PredefinedTextRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ID>0</ID>
<PredefinedText>
<PredefinedText>
<ID>0</ID>
<Text>String</Text>
<Type>String</Type>
</PredefinedText>
</PredefinedText>
<Type>String</Type>
</PredefinedTextRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PredefinedTextResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<PredefinedText>
<PredefinedText>
<ID>0</ID>
<Text>String</Text>
<Type>String</Type>
</PredefinedText>
</PredefinedText>
<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>
</PredefinedTextResponse>