Trendsic Platform Service

<back to all web services

NCESGetDropdownsRequest

<?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 NCESDropdown implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var string|null */
        public ?string $Name=null
    ) {
    }

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

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

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

class NCESGetDropdownsRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $StateID=0,
        /** @var int */
        public int $CountyID=0,
        /** @var int */
        public int $DistrictID=0
    ) {
    }

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

PHP NCESGetDropdownsRequest DTOs

GET /v1/NCES/GetDropdowns 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
		}
	},
	Dropdowns: 
	[
		{
			ID: 0,
			Name: String
		}
	]
}