Get Capacity

Request
Description Calculate the overall capacity per territory for a specific date range.
Context https://<instance>.optimizemyday.com/omdservices-basic/rest/v1/services/data
URL /getCapacity
Method GET
Response Code 200 when successful, another HTTP status code otherwise
Success Response The list of matches. Note that, for contractual reasons, matches do not contain (latitude, longitude) information.
Response Type XML or JSON
Parameter Datatype Description
configId Integer The identifier of the configuration.
dateFrom Date The lower end of the date range.
dateTo Date The upper end of the date range.
territoryId String The list of territories for which the capacity calculation is requested.
aggregate Date The level for which the calculation is requested. Available values are month, week and date. If omitted, the parameter defaults to date.
_output String The requested output format being xml or json. If omitted, xml is assumed.

Sample Call

https://sandbox.optimizemyday.com/omdservices-basic/rest/v1/services/data/getCapacity?configId=16167225&dateFrom=2017-09-20&dateTo=2017-09-27&aggregate=week

Sample Result

<Result success="true">
  <Capacity type="workingHours" territory="104" date="38" value="4860.0"/>
  <Capacity type="workingHours" territory="104" date="39" value="4860.0"/>
  <Capacity type="workingHours" territory="112" date="38" value="1620.0"/>
  <Capacity type="workingHours" territory="112" date="39" value="1620.0"/>
  <Capacity type="workingHours" territory="105" date="38" value="6480.0"/>
  <Capacity type="workingHours" territory="105" date="39" value="6480.0"/>
</Result>

results matching ""

    No results matching ""