Trendsic Platform Service

<back to all web services

SlotDistrictAgentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET/v1/SlotDistrictAgent/{AVPID}
DELETE,OPTIONS/v1/SlotDistrictAgent/{SlotDistrictID}/{AgentID}/{SchoolID}
<?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 SlotDistrictAgent implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SlotDistrictID=0,
        /** @var int */
        public int $AgentID=0,
        /** @var int */
        public int $SchoolID=0,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var string|null */
        public ?string $DistrictName=null,
        /** @var string|null */
        public ?string $SchoolName=null,
        /** @var string|null */
        public ?string $County=null,
        /** @var string|null */
        public ?string $State=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SlotDistrictID'])) $this->SlotDistrictID = $o['SlotDistrictID'];
        if (isset($o['AgentID'])) $this->AgentID = $o['AgentID'];
        if (isset($o['SchoolID'])) $this->SchoolID = $o['SchoolID'];
        if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
        if (isset($o['DistrictName'])) $this->DistrictName = $o['DistrictName'];
        if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
        if (isset($o['County'])) $this->County = $o['County'];
        if (isset($o['State'])) $this->State = $o['State'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SlotDistrictID)) $o['SlotDistrictID'] = $this->SlotDistrictID;
        if (isset($this->AgentID)) $o['AgentID'] = $this->AgentID;
        if (isset($this->SchoolID)) $o['SchoolID'] = $this->SchoolID;
        if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
        if (isset($this->DistrictName)) $o['DistrictName'] = $this->DistrictName;
        if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
        if (isset($this->County)) $o['County'] = $this->County;
        if (isset($this->State)) $o['State'] = $this->State;
        return empty($o) ? new class(){} : $o;
    }
}

class SlotDistrictAgentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var array<SlotDistrictAgent>|null */
        public ?array $SlotDistrictAgent=null
    ) {
    }

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

class SlotDistrictAgentRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AVPID=0,
        /** @var int */
        public int $SlotDistrictID=0,
        /** @var int */
        public int $AgentID=0,
        /** @var int */
        public int $SchoolID=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AVPID'])) $this->AVPID = $o['AVPID'];
        if (isset($o['SlotDistrictID'])) $this->SlotDistrictID = $o['SlotDistrictID'];
        if (isset($o['AgentID'])) $this->AgentID = $o['AgentID'];
        if (isset($o['SchoolID'])) $this->SchoolID = $o['SchoolID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AVPID)) $o['AVPID'] = $this->AVPID;
        if (isset($this->SlotDistrictID)) $o['SlotDistrictID'] = $this->SlotDistrictID;
        if (isset($this->AgentID)) $o['AgentID'] = $this->AgentID;
        if (isset($this->SchoolID)) $o['SchoolID'] = $this->SchoolID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SlotDistrictAgentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/SlotDistrictAgent/{AVPID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SlotDistrictAgentResponse 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>
  <SlotDistrictAgent>
    <SlotDistrictAgent>
      <AgentID>0</AgentID>
      <AgentName>String</AgentName>
      <County>String</County>
      <DistrictName>String</DistrictName>
      <SchoolID>0</SchoolID>
      <SchoolName>String</SchoolName>
      <SlotDistrictID>0</SlotDistrictID>
      <State>String</State>
    </SlotDistrictAgent>
  </SlotDistrictAgent>
  <Success>false</Success>
</SlotDistrictAgentResponse>