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