HTTP + SOAP11
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api3.appreciationfinancial.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: NCESSchoolRequest
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<NCESSchoolRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
<School>
<CountyId>0</CountyId>
<CountyName>String</CountyName>
<DistrictId>0</DistrictId>
<DistrictName>String</DistrictName>
<SchoolId>0</SchoolId>
<SchoolName>String</SchoolName>
<StateAbrev>String</StateAbrev>
<StateId>0</StateId>
<StateName>String</StateName>
<AVPName>String</AVPName>
<Address1>String</Address1>
<AgentName>String</AgentName>
<City>String</City>
<DateApproved>0001-01-01T00:00:00</DateApproved>
<DateModified>0001-01-01T00:00:00</DateModified>
<HasComments>false</HasComments>
<IsClosed>false</IsClosed>
<IsUnassigned>false</IsUnassigned>
<MilesAway>0</MilesAway>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<NumEmployees>0</NumEmployees>
<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>
<SlotDistrictID>0</SlotDistrictID>
<Status>String</Status>
<Status_Midland>false</Status_Midland>
<Status_NLG>false</Status_NLG>
<Status_Other>false</Status_Other>
<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>
</School>
<SchoolID>0</SchoolID>
</NCESSchoolRequest>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<NCESSchoolResponse 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>
<School>
<SchoolExtended>
<CountyId>0</CountyId>
<CountyName>String</CountyName>
<DistrictId>0</DistrictId>
<DistrictName>String</DistrictName>
<SchoolId>0</SchoolId>
<SchoolName>String</SchoolName>
<StateAbrev>String</StateAbrev>
<StateId>0</StateId>
<StateName>String</StateName>
<AVPName>String</AVPName>
<Address1>String</Address1>
<AgentName>String</AgentName>
<City>String</City>
<DateApproved>0001-01-01T00:00:00</DateApproved>
<DateModified>0001-01-01T00:00:00</DateModified>
<HasComments>false</HasComments>
<IsClosed>false</IsClosed>
<IsUnassigned>false</IsUnassigned>
<MilesAway>0</MilesAway>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<NumEmployees>0</NumEmployees>
<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>
<SlotDistrictID>0</SlotDistrictID>
<Status>String</Status>
<Status_Midland>false</Status_Midland>
<Status_NLG>false</Status_NLG>
<Status_Other>false</Status_Other>
<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>
</SchoolExtended>
</School>
</NCESSchoolResponse>
</soap:Body>
</soap:Envelope>