| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/SlotDistrict/Search |
|---|
"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 SlotDistrictSearchResponse {
/** @param {{ResponseStatus?:ResponseStatus,SlotDistrict?:SlotDistrict[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {SlotDistrict[]} */
SlotDistrict = [];
}
export class SlotDistrictSearchRequest {
/** @param {{State?:string,County?:string,City?:string,Zip?:string,Name?:string,Miles?:number,NLG?:boolean,Midland?:boolean,GreatAmerican?:boolean,VOYA?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
State;
/** @type {string} */
County;
/** @type {string} */
City;
/** @type {string} */
Zip;
/** @type {string} */
Name;
/** @type {?number} */
Miles;
/** @type {boolean} */
NLG;
/** @type {boolean} */
Midland;
/** @type {boolean} */
GreatAmerican;
/** @type {boolean} */
VOYA;
}
JavaScript SlotDistrictSearchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/SlotDistrict/Search HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SlotDistrictSearchResponse 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>
<SlotDistrict>
<SlotDistrict>
<Address_Mailing>String</Address_Mailing>
<Address_Physical>String</Address_Physical>
<City>String</City>
<County>String</County>
<DistrictId>0</DistrictId>
<DistrictName>String</DistrictName>
<HasComments>false</HasComments>
<ID>0</ID>
<MVP>0</MVP>
<MilesAway>0</MilesAway>
<Name>String</Name>
<NumEmployees>0</NumEmployees>
<NumSchools>0</NumSchools>
<Phone>String</Phone>
<RVP>0</RVP>
<Schools>
<SlotDistrictSchool>
<AgentList>
<SchoolAgent>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
<SlotDistrictApprovalID>0</SlotDistrictApprovalID>
</SchoolAgent>
</AgentList>
<SchoolId>0</SchoolId>
<SchoolName>String</SchoolName>
</SlotDistrictSchool>
</Schools>
<State>String</State>
<StateId>0</StateId>
<Status_Great_American>false</Status_Great_American>
<Status_Midland>false</Status_Midland>
<Status_NLG>false</Status_NLG>
<Status_VOYA>false</Status_VOYA>
<Type>String</Type>
<Zip>String</Zip>
<Zip_4>String</Zip_4>
</SlotDistrict>
</SlotDistrict>
</SlotDistrictSearchResponse>