Trendsic Platform Service

<back to all web services

SlotDistrictRequest

Requires Authentication
Required roles:Administrator, AdministratorRequires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
PUT,DELETE,OPTIONS/v1/SlotDistrict/{ID}
POST,OPTIONS/v1/SlotDistrict
"use strict";
export class SchoolAgent {
    /** @param {{AgentId?:number,AgentName?:string,SlotDistrictApprovalID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
    /** @type {number} */
    SlotDistrictApprovalID;
}
export class SlotDistrictSchool {
    /** @param {{SchoolId?:number,SchoolName?:string,AgentList?:SchoolAgent[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SchoolId;
    /** @type {string} */
    SchoolName;
    /** @type {SchoolAgent[]} */
    AgentList = [];
}
export class SlotDistrict {
    /** @param {{ID?:number,Name?:string,County?:string,DistrictId?:number,DistrictName?:string,Address_Physical?:string,Address_Mailing?:string,City?:string,Zip?:string,Zip_4?:string,StateId?:number,State?:string,Phone?:string,NumEmployees?:number,NumSchools?:number,Type?:string,Status_NLG?:boolean,Status_Midland?:boolean,Status_Great_American?:boolean,Status_VOYA?:boolean,MVP?:number,RVP?:number,Schools?:SlotDistrictSchool[],MilesAway?:number,HasComments?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Name;
    /** @type {string} */
    County;
    /** @type {number} */
    DistrictId;
    /** @type {string} */
    DistrictName;
    /** @type {string} */
    Address_Physical;
    /** @type {string} */
    Address_Mailing;
    /** @type {string} */
    City;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Zip_4;
    /** @type {number} */
    StateId;
    /** @type {string} */
    State;
    /** @type {string} */
    Phone;
    /** @type {?number} */
    NumEmployees;
    /** @type {?number} */
    NumSchools;
    /** @type {string} */
    Type;
    /** @type {boolean} */
    Status_NLG;
    /** @type {boolean} */
    Status_Midland;
    /** @type {boolean} */
    Status_Great_American;
    /** @type {boolean} */
    Status_VOYA;
    /** @type {?number} */
    MVP;
    /** @type {?number} */
    RVP;
    /** @type {SlotDistrictSchool[]} */
    Schools = [];
    /** @type {?number} */
    MilesAway;
    /** @type {boolean} */
    HasComments;
}
export class SlotDistrictResponse {
    /** @param {{ResponseStatus?:ResponseStatus,SlotDistrict?:SlotDistrict[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SlotDistrict[]} */
    SlotDistrict = [];
}
export class SlotDistrictRequest {
    /** @param {{SlotDistrict?:SlotDistrict,ID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SlotDistrict} */
    SlotDistrict;
    /** @type {number} */
    ID;
}

JavaScript SlotDistrictRequest 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.

POST /v1/SlotDistrict HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SlotDistrict: 
	{
		ID: 0,
		Name: String,
		County: String,
		DistrictId: 0,
		DistrictName: String,
		Address_Physical: String,
		Address_Mailing: String,
		City: String,
		Zip: String,
		Zip_4: String,
		StateId: 0,
		State: String,
		Phone: String,
		NumEmployees: 0,
		NumSchools: 0,
		Type: String,
		Status_NLG: False,
		Status_Midland: False,
		Status_Great_American: False,
		Status_VOYA: False,
		MVP: 0,
		RVP: 0,
		Schools: 
		[
			{
				SchoolId: 0,
				SchoolName: String,
				AgentList: 
				[
					{
						AgentId: 0,
						AgentName: String,
						SlotDistrictApprovalID: 0
					}
				]
			}
		],
		MilesAway: 0,
		HasComments: False
	},
	ID: 0
}
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
		}
	},
	SlotDistrict: 
	[
		{
			ID: 0,
			Name: String,
			County: String,
			DistrictId: 0,
			DistrictName: String,
			Address_Physical: String,
			Address_Mailing: String,
			City: String,
			Zip: String,
			Zip_4: String,
			StateId: 0,
			State: String,
			Phone: String,
			NumEmployees: 0,
			NumSchools: 0,
			Type: String,
			Status_NLG: False,
			Status_Midland: False,
			Status_Great_American: False,
			Status_VOYA: False,
			MVP: 0,
			RVP: 0,
			Schools: 
			[
				{
					SchoolId: 0,
					SchoolName: String,
					AgentList: 
					[
						{
							AgentId: 0,
							AgentName: String,
							SlotDistrictApprovalID: 0
						}
					]
				}
			],
			MilesAway: 0,
			HasComments: False
		}
	]
}