Delete consolidated clockguards

This endpoint allows you to delete the consolidated clockguards linked to a product on a specific day.

DELETE /api/v1/businesses/{businessId}/product/{productId}/clockguards/date/{yyyy-MM-dd}?overlapOption={overlapOption}

Through the overlapOption request parameter, you can configure the operation to determine whether clockguards that extend over two consecutive days should be deleted or not.

  • NONE: clockguards that span two consecutive days are excluded.

  • END: clockguards that overlap with consecutive days are deleted.

  • FULL: all overlapping clockguards are deleted.

Below is an example of the behavior of this request considering the following consolidated clockguards:

clockguards en

  • NONE

  • END

  • FULL

Only the clockguards of the request day that does not overlap with any other day are deleted.

clockguards en none

Clockguards of the request day are deleted, including those that overlap with the following day.

clockguards en end

All clockguards of the request day are deleted, including those that overlap with the preceding and following days.

clockguards en full

Considerations

This request deletes the consolidated clockguards but not the records.

If the product specified in the URL does not exist in the business, the request will return a 404 Not Found error, specifying in the message not exists.

Useful links

What is a clockguard?

How to integrate clockguards?