Click or drag to resize
ParaPlan Logo

How To Get Program Participants

Program admin is the person who is registered with the Agency and is authorized to book riders on the user's behalf.

This document will show you how to get a list of clients that the program admin can interact with.

The return JSON will be a ListResponseT of ParaPlanREST.ModelsClient

Usage
Important note Important

Make sure to use the restURL collected during login process

Get Clients

  • Send a GET request to ProgramParticipants(String, String):

    C#
    1var listOfClientsUrl = $"{storedrestURL}ClientService/Client/ProgramParticipants/?token={token}&Device={device}";
    2using (WebClient client = new WebClient())
    3{
    4    string s = client.DownloadString(listOfClientsUrl);
    5    var clientList = JsonConvert.DeserializeObject<ListResponse<Client>>(s);
    6
    7}
    Result
      {
        "errorMessage": "",
        "success": true,
        "tokenExists": true,
        "tokenIsValid": true,
        "list":[{
                "errorMessage": "",
                "success": false,
                "tokenExists": true,
                "tokenIsValid": true,
                "accessibility": {
                    "errorMessage": "",
                    "success": false,
                    "tokenExists": true,
                    "tokenIsValid": true,
                    "accessibilityItems": [],
                    "equipmentType": [],
                    "extraTime": 0,
                    "hasPCA": false,
                    "isPersonWithDisability": false,
                    "needsWheelchairVan": false,
                    "usesWheelchair": false
                },
                "appointments": null,
                "birthDateJson": "1965-02-16T00:00:00.0000000",
                "birthdate": "/Date(-153792000000+0000)/",
                "home": {
                    "errorMessage": "",
                    "success": false,
                    "tokenExists": true,
                    "tokenIsValid": true,
                    "address1": "1939 STRAIGHT CREEK RD",
                    "address2": "",
                    "city": "WAVERLY",
                    "lat": 39.0556475,
                    "lng": -82.9026116,
                    "name": "Home",
                    "phone": "740 226-1228",
                    "state": "OH",
                    "zip": "45690"
                },
                "id": 19430,
                "name": "BERCHIE ADAMS",
                "notes": "",
                "phone": "740 226-1228",
                "specialNeeds": "",
                "subscriptions": null
            },
            {
                "errorMessage": "",
                "success": false,
                "tokenExists": true,
                "tokenIsValid": true,
                "accessibility": {
                    "errorMessage": "",
                    "success": false,
                    "tokenExists": true,
                    "tokenIsValid": true,
                    "accessibilityItems": [],
                    "equipmentType": [],
                    "extraTime": 0,
                    "hasPCA": false,
                    "isPersonWithDisability": false,
                    "needsWheelchairVan": false,
                    "usesWheelchair": false
                },
                "appointments": null,
                "birthDateJson": "2004-02-26T00:00:00.0000000",
                "birthdate": "/Date(1077753600000+0000)/",
                "home": {
                    "errorMessage": "",
                    "success": false,
                    "tokenExists": true,
                    "tokenIsValid": true,
                    "address1": "17 N MCARTHUR ST",
                    "address2": "",
                    "city": "CHILLICOTHE",
                    "lat": 39.3365863,
                    "lng": -82.9679505,
                    "name": "Home",
                    "phone": "740 851-5584",
                    "state": "OH",
                    "zip": "45601"
                },
                "id": 19418,
                "name": "KANE ALGEO",
                "notes": "",
                "phone": "740 851-5584",
                "specialNeeds": "",
                "subscriptions": null
            }]
    }