POST api/directory/institutions

Back to API Documentation

This method returns a list of institutions currently available for this API Key that match the given input parameters (ORed together within a parameter, but ANDed together across parameters). Output order is based upon Eddy’s own internal optimization algorithm.

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
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
SubjectIds	Subject(s) Comma-delimited list of SubjectIds.	Collection of integer

Request Format

Conten-Type: application/json

            {
                 "InstitutionId": "141",
                 "CampusType": "All",
                 "APIKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                 "CategoryIds": [25,21],
                 "SubjectIds": [658],
                 "ProgramLevelIds": [2,3,6,18,22,8],
                 "PageSize": 10,
                 "StartPage": 1
             }

Response Information

Output

        {
                "IsSuccessful": true,
                "Body": {
                    "StartPage": 1,
                    "PageSize": 10,
                    "TotalItems": 1,
                    "TotalPages": 1,
                    "ItemList": [
                  {
                       "InstitutionId": 141,
                            "InstitutionName": "Rasmussen College",
                            "InstitutionDescription": "tFlex Choice: Online, On Campus",
                            "LogoURL": "http://content.educationdynamics.local/logo/141/Logo_240x80.gif",
                            "InstitutionFormURL": "www.elearners.com/a/Mydirectory/form/141",
                            "Campuses": [
                                {
                                    "CampusId": 9306,
                                    "CampusName": "Wausau, WI",
                                    "Address": "1101 Westwood Dr",
                                    "City": "Wausau",
                                    "Country": {
                                        "CountryId": 4,
                                        "Name": "United States",
                                        "CountryCode": "US"
                                    },
                                    "State": {
                                        "StateId": 51,
                                        "Name": "Wisconsin",
                                        "StateCode": "WI"
                                    },
                                    "CampusType": "Ground",
                                    "PostalCode": "54401"
                                }]
                    ]
                },
                "ResponseDateTime": "2017-01-20T10:11:07.7055258-05:00",
                "RequestDateTime": "2017-01-20T10:11:07.6331136-05:00",
                "ResponseGuid": "a9f58bb4-dc4f-474a-ae7d-e52576139152",
                "Messages": [
                    {
                        "MessageCode": "msg0038",
                        "Message": "Validation Passed."
                    }
                ],
                "TotalResponseTime": 74
            }