HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /xml/reply/SlotDistrictRequest HTTP/1.1
Host: api5.appreciationfinancial.com
Content-Type: application/xml
Content-Length: length
<SlotDistrictRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
<DistrictId>0</DistrictId>
<ID>0</ID>
<SlotDistrict>
<Address_Mailing>String</Address_Mailing>
<Address_Physical>String</Address_Physical>
<City>String</City>
<County>String</County>
<DateModified>0001-01-01T00:00:00</DateModified>
<DistrictId>0</DistrictId>
<DistrictName>String</DistrictName>
<HasComments>false</HasComments>
<ID>0</ID>
<IsClosed>false</IsClosed>
<MVP>0</MVP>
<MilesAway>0</MilesAway>
<ModifiedBy>String</ModifiedBy>
<Name>String</Name>
<Notes>String</Notes>
<NumEmployees>0</NumEmployees>
<NumSchools>0</NumSchools>
<Other403Vendors>
<OtherVendors>
<CommonName>String</CommonName>
<FullName>String</FullName>
<ID>0</ID>
<Name>String</Name>
<Phone>String</Phone>
<URL>String</URL>
<VendorType>String</VendorType>
</OtherVendors>
</Other403Vendors>
<Other457Vendors>
<OtherVendors>
<CommonName>String</CommonName>
<FullName>String</FullName>
<ID>0</ID>
<Name>String</Name>
<Phone>String</Phone>
<URL>String</URL>
<VendorType>String</VendorType>
</OtherVendors>
</Other457Vendors>
<OtherVendors>String</OtherVendors>
<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_Other>false</Status_Other>
<Status_VOYA>false</Status_VOYA>
<TPADocuments>
<Slot_TPADocument>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DocumentUID>00000000-0000-0000-0000-000000000000</DocumentUID>
<FileName>String</FileName>
<FilePath>String</FilePath>
<FileSizeInKB>0</FileSizeInKB>
<ID>0</ID>
<TPAID>0</TPAID>
<TPAName>String</TPAName>
<TPAType>String</TPAType>
<TPATypeID>0</TPATypeID>
</Slot_TPADocument>
</TPADocuments>
<TPA_403B>0</TPA_403B>
<TPA_403B_Name>String</TPA_403B_Name>
<TPA_403B_URL>String</TPA_403B_URL>
<Type>String</Type>
<Website>String</Website>
<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/Bombshell.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:ResponseError>
</d2p1:Errors>
</ResponseStatus>
<SlotDistrict>
<SlotDistrict>
<Address_Mailing>String</Address_Mailing>
<Address_Physical>String</Address_Physical>
<City>String</City>
<County>String</County>
<DateModified>0001-01-01T00:00:00</DateModified>
<DistrictId>0</DistrictId>
<DistrictName>String</DistrictName>
<HasComments>false</HasComments>
<ID>0</ID>
<IsClosed>false</IsClosed>
<MVP>0</MVP>
<MilesAway>0</MilesAway>
<ModifiedBy>String</ModifiedBy>
<Name>String</Name>
<Notes>String</Notes>
<NumEmployees>0</NumEmployees>
<NumSchools>0</NumSchools>
<Other403Vendors>
<OtherVendors>
<CommonName>String</CommonName>
<FullName>String</FullName>
<ID>0</ID>
<Name>String</Name>
<Phone>String</Phone>
<URL>String</URL>
<VendorType>String</VendorType>
</OtherVendors>
</Other403Vendors>
<Other457Vendors>
<OtherVendors>
<CommonName>String</CommonName>
<FullName>String</FullName>
<ID>0</ID>
<Name>String</Name>
<Phone>String</Phone>
<URL>String</URL>
<VendorType>String</VendorType>
</OtherVendors>
</Other457Vendors>
<OtherVendors>String</OtherVendors>
<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_Other>false</Status_Other>
<Status_VOYA>false</Status_VOYA>
<TPADocuments>
<Slot_TPADocument>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DocumentUID>00000000-0000-0000-0000-000000000000</DocumentUID>
<FileName>String</FileName>
<FilePath>String</FilePath>
<FileSizeInKB>0</FileSizeInKB>
<ID>0</ID>
<TPAID>0</TPAID>
<TPAName>String</TPAName>
<TPAType>String</TPAType>
<TPATypeID>0</TPATypeID>
</Slot_TPADocument>
</TPADocuments>
<TPA_403B>0</TPA_403B>
<TPA_403B_Name>String</TPA_403B_Name>
<TPA_403B_URL>String</TPA_403B_URL>
<Type>String</Type>
<Website>String</Website>
<Zip>String</Zip>
<Zip_4>String</Zip_4>
</SlotDistrict>
</SlotDistrict>
</SlotDistrictResponse>