Bombshell Agency Platform Service

<back to all web services

NCESSchoolRequest

The following routes are available for this service:
GET,POST,OPTIONS/v1/NCES/School
GET,PUT,OPTIONS/v1/NCES/School/{SchoolID}

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/NCESSchoolRequest HTTP/1.1 
Host: api5.appreciationfinancial.com 
Content-Type: text/csv
Content-Length: length

School,SchoolID
"{Address1:String,City:String,Zip:String,Phone:String,Website:String,IsClosed:False,ModifiedBy:String,DateModified:0001-01-01,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-01,Notes:String,SchoolId:0,SchoolName:String,DistrictId:0,DistrictName:String,CountyId:0,CountyName:String,StateId:0,StateName:String,StateAbrev:String}",0

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

ResponseStatus,School
"{ErrorCode:String,Message:String,StackTrace:String,Errors:[{ErrorCode:String,FieldName:String,Message:String}]}","[{Address1:String,City:String,Zip:String,Phone:String,Website:String,IsClosed:False,ModifiedBy:String,DateModified:0001-01-01,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-01,Notes:String,SchoolId:0,SchoolName:String,DistrictId:0,DistrictName:String,CountyId:0,CountyName:String,StateId:0,StateName:String,StateAbrev:String}]"