| 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 |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SchoolAgent:
agent_id: int = 0
agent_name: Optional[str] = None
slot_district_approval_i_d: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SlotDistrictSchool:
school_id: int = 0
school_name: Optional[str] = None
agent_list: List[SchoolAgent] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SlotDistrict:
id: int = 0
name: Optional[str] = None
county: Optional[str] = None
district_id: int = 0
district_name: Optional[str] = None
address__physical: Optional[str] = None
address__mailing: Optional[str] = None
city: Optional[str] = None
zip: Optional[str] = None
zip_4: Optional[str] = None
state_id: int = 0
state: Optional[str] = None
phone: Optional[str] = None
num_employees: Optional[Decimal] = None
num_schools: Optional[int] = None
type: Optional[str] = None
status__n_l_g: bool = False
status__midland: bool = False
status__great__american: bool = False
status__v_o_y_a: bool = False
mvp: Optional[int] = None
rvp: Optional[int] = None
schools: List[SlotDistrictSchool] = field(default_factory=list)
miles_away: Optional[float] = None
has_comments: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SlotDistrictResponse:
response_status: Optional[ResponseStatus] = None
slot_district: List[SlotDistrict] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SlotDistrictRequest:
slot_district: Optional[SlotDistrict] = None
id: int = 0
Python SlotDistrictRequest 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.
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>