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

export class SchoolAgent
{
    public AgentId: number;
    public AgentName: string;
    public SlotDistrictApprovalID: number;

    public constructor(init?: Partial<SchoolAgent>) { (Object as any).assign(this, init); }
}

export class SlotDistrictSchool
{
    public SchoolId: number;
    public SchoolName: string;
    public AgentList: SchoolAgent[] = [];

    public constructor(init?: Partial<SlotDistrictSchool>) { (Object as any).assign(this, init); }
}

export class SlotDistrict
{
    public ID: number;
    public Name: string;
    public County: string;
    public DistrictId: number;
    public DistrictName: string;
    public Address_Physical: string;
    public Address_Mailing: string;
    public City: string;
    public Zip: string;
    public Zip_4: string;
    public StateId: number;
    public State: string;
    public Phone: string;
    public NumEmployees?: number;
    public NumSchools?: number;
    public Type: string;
    public Status_NLG: boolean;
    public Status_Midland: boolean;
    public Status_Great_American: boolean;
    public Status_VOYA: boolean;
    public MVP?: number;
    public RVP?: number;
    public Schools: SlotDistrictSchool[] = [];
    public MilesAway?: number;
    public HasComments: boolean;

    public constructor(init?: Partial<SlotDistrict>) { (Object as any).assign(this, init); }
}

export class SlotDistrictResponse
{
    public ResponseStatus: ResponseStatus;
    public SlotDistrict: SlotDistrict[] = [];

    public constructor(init?: Partial<SlotDistrictResponse>) { (Object as any).assign(this, init); }
}

export class SlotDistrictRequest
{
    public SlotDistrict: SlotDistrict;
    public ID: number;

    public constructor(init?: Partial<SlotDistrictRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}