| Method | URL Template | Headers | Values/Format | Required |
| POST | /api/clientsapi | ApiKey
UnassignedOnly ClientEmail BeginDate EndDate |
string
bool string yyyy-mm-dd hh:mm:ss.ms yyyy-mm-dd hh:mm:ss.ms |
true
false false false true |
Example Post
POST http://studentdebt.solutions/api/clientslistapi HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=UTF-8
{
"ApiKey":"12345678-C123-456A-A1FA-2C34567891",
"UnassignedOnly":"true",
"ClientEmail":"jdoe@studentdebt.solutions",
"BeginDate":"2016-04-27 19:03:00.67",
"EndDate":"2016-04-29 19:03:00.67"
}
Example Return
{
"Address1":"777 Oak St",
"Address2":"Unit 100",
"AgencyName":"FamilyMeans",
"AnnualIncome":"75000",
"City":"Orlando",
"CounselorEmail":"",
"DateCreated":"2016-04-28T19:03:00.67",
"Disabled":"false",
"Email":"jdoe@studentdebt.solutions",
"FamilySize":"3",
"FirstNam":"John",
"LastName":"Doe",
"Married":"True",
"MonthlyIncome":"5000",
"Phone":"(null)",
"State":"FL",
"Zip":"32996"
}
Notes
-
ApiKey is to be provided by your distributor.
-
Begin and end dates both use a 24 hour clock. EndDate must be specified with or without a BeginDate in order to successfully return query results.
-
Results are returned in JSON format and include all clients unless the UnassignedOnly boolean is set to true.