Delta API Endpoints and Requests

Need to speak with Tejas about how we are versioning.

When they request prod URL, billing begins

 

Call these endpoints to receive a location's delta records in JSON format. Delta requests are processed in real-time, so records that were changed (added, edited, or deleted) from the Start Date until about 5 minutes ago will be captured and included in the response.

Delta endpoints

All requests must include the bearer JSON Web Token, tenant ID, location ID, and start date.

Get changes to Client profiles

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/Client/changes

Get changes to Employee profiles

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/Employee/changes

Get changes to Appointment records

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/Appointment/changes

Get changes to Sale records

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/Sale/changes

Get changes to Employee Schedules

This entity is available upon request.

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/EmployeeSchedule/changes

Get changes to Employee Actuals

This entity is available upon request.

GET  {{publicApiURL}}/publicapi/v1/cdc/entity/EmployeeActual/changes

Request parameters

Pass these as query parameters, making sure to include the required parameters.

Parameter

Data Type

Definition

TenantID*

integer

The ID of the tenant whose information is being requested. This Parameter must be included in every request.

Tip: Use the apps/tenant endpoint to view all tenant and location ids that have been activated by your app.

LocationID*

integer

The location in the tenant from which information is being pulled. This Parameter must be included in every request.

Tip: Use the apps/tenant endpoint to view all tenant and location ids that have been activated by your app.

PageNumber

integer

The page number of results that your query will begin on. This parameter defaults to 0 if it is not specified in the request.

ItemsPerPage

integer

How many results will display per page; maximum is 200 results. This parameter defaults to 50 if it is not specified in the request.

verify

StartDate*

datetime

The request will retrieve any changes to historical data that were made from this date forward. You can go back as far as 7 days. This Parameter must be included in every request.

RequestID

integer (guid)

An optional GUID of the request, which is an ID unique to each caller.

*Required parameters

StartDate

The StartDate is a required datetime parameter that determines the starting point from which deltas will be returned. Each response contains a lastChangeDateIncludedInPage field, which indicates the date and time of the most recent change captured on that page. If you are making several calls for deltas in the same day, you can use this value as your StartDate in the next call to return only those deltas that occurred between your last call and now.

Pagination

Each page displays the number of results (ItemsPerPage) starting on the defined PageNumber. For example, if a query will return 410 results:

  • Setting PageNumber to 0 and ItemsPerPage to 200: Page 0 displays results 1-200, Page 1 displays results 201-401, and Page 2 displays results 402-410.
  • Setting PageNumber to 1 and ItemsPerPage to 200: Page 1 displays results 201-401, and Page 2 displays results 402-410.

Example call

The Test Bed URL is https://d18devpub.meevodev.com. You can review our section on the Meevo DDS Test Bed if you are unfamiliar with this environment.

A request for Client deltas might look something like this. Remember, the StartDate can be a maximum of 7 days ago.

GET  
https://d18devpub.meevodev.com/publicapi/v1/cdc/entity/Client/changes?tenantid=1&locationid=2&StartDate=2020-07-18

Example response

The response includes any record that was added, updated, or deleted in the time since the StartDate. See Understanding Delta Responses for details on what to expect and how to interpret some of this data.