We recently observed some performance issues in the
Get all departments API. Our root cause analysis revealed that these issues were caused by the inclusion of the
associatedAgentIds key in the API response. To eliminate this performance issue, we have decided to deprecate this key from the API response.
However, this change does not affect the
Get a department API. So, as an alternative, you can get the
associatedAgentIds key through the response to this API.
Besides, we have also enhanced the
Get all departments API by introducing the
from and
limit query parameters in the API request. The
from parameter enables you to fetch departments, starting from a particular index, while the
limit parameter enables you to set the number of departments the API request must fetch. The default value of the
limit parameter is 10 and the maximum value you can set is 200.
Another API that will benefit from the inclusion of default and maximum values for the limit parameter is
List all agents. Like in the case of the
Get all departments API, the default value is 10 and maximum value is 200 in this API too.
The
associatedAgentIds key will be deprecated from the
Get all departments API by
31st March, 2018. Therefore, you are requested to update your code to reflect this change before the said date. Similarly, the
from and
limit parameters will be applicable without fail from 31st March, 2018. Failing to define the
limit parameter would lead the API to consider the default value for the parameter, which is 10 resources per request. Therefore, you are requested to update your code to accommodate these parameters too before the said date.