POST api/directory/programlevels

This method returns a list of all currently available program levels for this API Key that match the given input parameters (ANDed together). The Level IDs returned can be used as inputs to the other API methods when filtering results.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type
APIKey	Required | Partner Credentials. This value will be provided by the EDDY Account Management team.	globally unique identifier
CampusType	Online or Ground or All	string
CategoryIds	Category(s) Comma-delimited list of CategoryIds.	Collection of integer
InstitutionId	Institution	integer
PageSize	Required | Number of records per page.	integer
StartPage	Required | Start page.	integer
SubjectIds	Subject(s) Comma-delimited list of SubjectIds.	Collection of integer

Request Format

Conten-Type: application/json

            {
                 "CampusType": "all",
                 "APIKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                 "CategoryIds": [25,21],
                 "SubjectIds": [658],
                 "PageSize": 10,
                 "StartPage": 1
               }
        

Response Information

Output

        {
                "IsSuccessful": true,
                "Body": {
                    "StartPage": 1,
                    "PageSize": 10,
                    "TotalItems": 2,
                    "TotalPages": 1,
                    "ItemList": [
                          {
                            "ProgramLevelId": 2,
                            "ProgramLevelName": "Associate"
                        },
                        {
                            "ProgramLevelId": 3,
                            "ProgramLevelName": "Bachelor"
                         }
                    ]
                },
                "ResponseDateTime": "2017-01-20T13:30:10.6270768-05:00",
                "RequestDateTime": "2017-01-20T13:30:10.6113456-05:00",
                "ResponseGuid": "5e497d0a-1be2-458e-b282-db100436ca12",
                "Messages": [
                    {
                        "MessageCode": "msg0038",
                        "Message": "Validation Passed."
                }
                ],
                "TotalResponseTime": 16
            }