| Required roles: | Administrator, Administrator | Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| PUT,DELETE,OPTIONS | /v1/SlotDistrict/{ID} | ||
|---|---|---|---|
| POST,OPTIONS | /v1/SlotDistrict |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SlotDistrict | body | SlotDistrict | No | |
| ID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| Name | form | string | No | |
| County | form | string | No | |
| DistrictId | form | int | No | |
| DistrictName | form | string | No | |
| Address_Physical | form | string | No | |
| Address_Mailing | form | string | No | |
| City | form | string | No | |
| Zip | form | string | No | |
| Zip_4 | form | string | No | |
| StateId | form | int | No | |
| State | form | string | No | |
| Phone | form | string | No | |
| NumEmployees | form | decimal? | No | |
| NumSchools | form | int? | No | |
| Type | form | string | No | |
| Status_NLG | form | bool | No | |
| Status_Midland | form | bool | No | |
| Status_Great_American | form | bool | No | |
| Status_VOYA | form | bool | No | |
| MVP | form | int? | No | |
| RVP | form | int? | No | |
| Schools | form | List<SlotDistrictSchool> | No | |
| MilesAway | form | double? | No | |
| HasComments | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SchoolId | form | long | No | |
| SchoolName | form | string | No | |
| AgentList | form | List<SchoolAgent> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentId | form | int | No | |
| AgentName | form | string | No | |
| SlotDistrictApprovalID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| SlotDistrict | form | List<SlotDistrict> | No |
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.
POST /v1/SlotDistrict HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SlotDistrictRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ID>0</ID>
<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>
</SlotDistrictRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SlotDistrictResponse 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>
</SlotDistrictResponse>