Removing an object from the /routing/queues/divisionviews response

Category: API

Summary: We will modify the response for the /routing/queues/divisionviews endpoint, removing some duplicated data. The current response format includes the queue listing twice, each in a different format. Currently there's a results array that looks like

    "results": [
        {
            "queueId": "b76d1f4a-63df-4630-a812-913df8ac90e3",
            "name": "MyQueue",
            "divisionId": "84eaba95-a150-4922-88b1-a9415cd91b57",
            "_type": "queues"
        }
        ...
    }

plus an entities array that looks like

    "entities": [
        {
            "id": "b76d1f4a-63df-4630-a812-913df8ac90e3",
            "name": "MyQueue",
            "division": {
                "id": "84eaba95-a150-4922-88b1-a9415cd91b57",
                "name": "Home",
                "selfUri": "/api/v2/authorization/divisions/84eaba95-a150-4922-88b1-a9415cd91b57"
            },
            "selfUri": "/api/v2/routing/queues/b76d1f4a-63df-4630-a812-913df8ac90e3"
        },
        ...
    }

The scheduled change will remove the results object from the response entirely. This change is being made in order to bring the response into compatibility with the other divisionviews endpoints. Note that other fields in the response (e.g. pageSize, pageNumber, total, etc.) will not be changed or removed.

Impact: Any code which uses the results object in the routing/queues/divisionviews response needs to be updated to use entities.

Date of Change: On or after February 15, 2018

Impacted APIs:

  • GET /routing/queues/divisionviews

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.