POST api/directory/categories

Back to API Documentation

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

Request Information

URI Parameters

None.

Body Parameters

NameDescriptionType
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
InstitutionId

Institution

integer
PageSize

Required | Number of records per page.

integer
ProgramLevelIds

Program Level(s) Comma-delimited list of ProgramLevelIds

Collection of integer
StartPage

Required | Start page.

integer

Request Format

Conten-Type: application/json
            {
                 "APIKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                 "StartPage": 1,
                 "PageSize": 10
             }
        

Response Information

Output

        {
                "IsSuccessful": true,
                "Body": {
                    "StartPage": 1,
                    "PageSize": 10,
                    "TotalItems": 2,
                    "TotalPages": 1,
                    "ItemList": [
                        {
                            "CategoryId": 21,
                            "CategoryName": "Business",
                            "DirectoryURL": "www.elearners.com/a/Mydirectory/search/programs?category=21",
                        }
                    ]
                },
                "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
            }
    

Please check additional information.