HTTP + JSON
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /json/reply/NCESSchoolRequest HTTP/1.1
Host: api3.appreciationfinancial.com
Content-Type: application/json
Content-Length: length
{"School":{"Address1":"String","City":"String","Zip":"String","Phone":"String","Website":"String","IsClosed":false,"ModifiedBy":"String","DateModified":"0001-01-01T00:00:00.0000000","SlotDistrictID":0,"Type":"String","NumEmployees":0,"Status_NLG":false,"Status_Midland":false,"Status_Other":false,"OtherVendors":"String","MilesAway":0,"HasComments":false,"TPA_403B":0,"TPA_403B_Name":"String","TPA_403B_URL":"String","Other403Vendors":[{"ID":0,"CommonName":"String","FullName":"String","Phone":"String","URL":"String","VendorType":"String","Name":"String"}],"Other457Vendors":[{"ID":0,"CommonName":"String","FullName":"String","Phone":"String","URL":"String","VendorType":"String","Name":"String"}],"AgentName":"String","AVPName":"String","DateApproved":"0001-01-01T00:00:00.0000000","Notes":"String","Status":"String","IsUnassigned":false,"SchoolId":0,"SchoolName":"String","DistrictId":0,"DistrictName":"String","CountyId":0,"CountyName":"String","StateId":0,"StateName":"String","StateAbrev":"String"},"SchoolID":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"School":[{"Address1":"String","City":"String","Zip":"String","Phone":"String","Website":"String","IsClosed":false,"ModifiedBy":"String","DateModified":"0001-01-01T00:00:00.0000000","SlotDistrictID":0,"Type":"String","NumEmployees":0,"Status_NLG":false,"Status_Midland":false,"Status_Other":false,"OtherVendors":"String","MilesAway":0,"HasComments":false,"TPA_403B":0,"TPA_403B_Name":"String","TPA_403B_URL":"String","Other403Vendors":[{"ID":0,"CommonName":"String","FullName":"String","Phone":"String","URL":"String","VendorType":"String","Name":"String"}],"Other457Vendors":[{"ID":0,"CommonName":"String","FullName":"String","Phone":"String","URL":"String","VendorType":"String","Name":"String"}],"AgentName":"String","AVPName":"String","DateApproved":"0001-01-01T00:00:00.0000000","Notes":"String","Status":"String","IsUnassigned":false,"SchoolId":0,"SchoolName":"String","DistrictId":0,"DistrictName":"String","CountyId":0,"CountyName":"String","StateId":0,"StateName":"String","StateAbrev":"String"}]}