POST api/directory/zipcodes

Back to API Documentation

This method returns a list of all zip codes for this API Key that match the given input parameters for the given campus.

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
CampusId	Required \| Campus Id.	integer

Request Format

Conten-Type: application/json

            {
                 "APIKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                 "CampusId": "622"        
                 
             }

Response Information

Output

        {
                "IsSuccessful": true,
                "Body": 
                    {
                        "CampusId": 622,
                        "ZipCode": [
                            17565,
                            17564,
                            17563
                        ]
                    },
                "ResponseDateTime": "2021-04-08T13:23:08.468054-06:00",
                "RequestDateTime": "2021-04-08T13:22:29.4296603-06:00",
                "ResponseGuid": "4c6e992d-df1e-4da2-8015-c07afa847b11",
                "Messages": [
                    {
                        "MessageCode": "msg0038",
                        "Message": "Validation Passed."
                    }
                ],
                "TotalResponseTime": 39039
            }