latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Manage-Changes

manage changes summary

Scopes: export_enrollment

get/v{version}/manage-changes-summary

Path parameters

versionstring required

Query parameters

agency_idstring

The broker company id

company_idstring

The client company id

fromstring date-time

The date and time to begin from, inclusive. Default is 90 in the past. Time is truncated to an hour.

tostring date-time

The date and time to end at, inclusive. The maximum time period allowed is 90 days. Time is truncated to an hour.

employee_start_idstring

The employee id to start with.

employee_limitinteger
query_mode'Actual' | 'Continuous'

Works in conjunction with "from" and "to" and determines how data is searched. <br /> "Actual" (default) will search based on when manage change record has been created. This mode is eventually consistent and can take over 24h for data to show up in extreme cases. <br /> "Continuous" mode searches based on when manage change record became available for search. <br /> When in "Continuous" mode it is recommended to use few minutes of delay when querying for a previous hour, e.g., if you want to query data from 2000-01-01 04:00 AM to 2000-01-01 07:00 AM, execute the query no earlier than 2000-01-01 07:05 AM.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.