Trendsic Platform Service

<back to all web services

SlotDistrictSchoolRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/SlotDistrict/School/{DistrictId}
<?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 School implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SchoolId=0,
        /** @var string|null */
        public ?string $SchoolName=null,
        /** @var int */
        public int $DistrictId=0,
        /** @var string|null */
        public ?string $DistrictName=null,
        /** @var int */
        public int $CountyId=0,
        /** @var string|null */
        public ?string $CountyName=null,
        /** @var int */
        public int $StateId=0,
        /** @var string|null */
        public ?string $StateName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SchoolId'])) $this->SchoolId = $o['SchoolId'];
        if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
        if (isset($o['DistrictId'])) $this->DistrictId = $o['DistrictId'];
        if (isset($o['DistrictName'])) $this->DistrictName = $o['DistrictName'];
        if (isset($o['CountyId'])) $this->CountyId = $o['CountyId'];
        if (isset($o['CountyName'])) $this->CountyName = $o['CountyName'];
        if (isset($o['StateId'])) $this->StateId = $o['StateId'];
        if (isset($o['StateName'])) $this->StateName = $o['StateName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SchoolId)) $o['SchoolId'] = $this->SchoolId;
        if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
        if (isset($this->DistrictId)) $o['DistrictId'] = $this->DistrictId;
        if (isset($this->DistrictName)) $o['DistrictName'] = $this->DistrictName;
        if (isset($this->CountyId)) $o['CountyId'] = $this->CountyId;
        if (isset($this->CountyName)) $o['CountyName'] = $this->CountyName;
        if (isset($this->StateId)) $o['StateId'] = $this->StateId;
        if (isset($this->StateName)) $o['StateName'] = $this->StateName;
        return empty($o) ? new class(){} : $o;
    }
}

class SlotDistrictSchoolResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<School>|null */
        public ?array $SlotDistrictSchool=null
    ) {
    }

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

class SlotDistrictSchoolRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DistrictId=0
    ) {
    }

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

PHP SlotDistrictSchoolRequest DTOs

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

HTTP + JSV

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

GET /v1/SlotDistrict/School/{DistrictId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	SlotDistrictSchool: 
	[
		{
			SchoolId: 0,
			SchoolName: String,
			DistrictId: 0,
			DistrictName: String,
			CountyId: 0,
			CountyName: String,
			StateId: 0,
			StateName: String
		}
	]
}