Config API Version 2 Report Schedule Subscribers

Introduction

Reports may be scheduled to be sent to multiple users of the Infinity system. These users, in a report context, are known as subscribers to a report schedule.

List Report Schedule Subscribers

Returns a list of Report Schedule Subscribers that the user can access.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/scheduledReports/{reportScheduleId}/subscribers

Response:

Returns a list of subscribers to a report schedule

{"userId":"42","username":"some.person@example.com","firstName":"Some","lastName":"Person","primaryOrgId":"1","status":"200"}
{"userId":"59","username":"other.person@example.com","firstName":"Other","lastName":"Person","primaryOrgId":"1","status":"200"}

Remove Report Schedule Subscribers

Unsubscribes a user from a specific report schedule

Request:

DELETE /config/v2/organisations/{ORG SPECIFIER}/scheduledReports/{reportScheduleId}/subscribers/{USER SPECIFIER}

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT