List Eligibility Subscriptions
GET/v1/eligibility-subscriptions
List Eligibility Subscriptions
Request​
Query Parameters
Possible values: [id
]
Field to sort
Possible values: [pending_validation_request
, validation_request_failed
, pending
, live
, cancelled
, cannot_define_eligibility
]
Start date to retrieve monitoring from.
Filter eligibility subscriptions based on whether there is a recognised Organisation tied to the subscription
A cursor that points to where to start the page
Default value: 25
How many items per page, for pagination.
Possible values: [ASC
, DESC
]
Which way to sort by the given 'sort' field. Default DESC
Responses​
- 200
- 400
- 401
- 403
Successfully retrieved a page of Eligibility Subscriptions
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
data object[]
suggestedActivitySubTags object[]nullable
SubTag name
tag object
Tag name
Tag description
SubTag description
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
, cannot_define_eligibility
]
results object
Possible values: [pass
, fail
]
confirmedActivitySubTags object[]nullable
SubTag name
tag object
Tag name
Tag description
SubTag description
rejectedActivitySubTags object[]nullable
Confirmed organisation's activity subtags that are not allowed in partner's configuration
SubTag name
tag object
Tag name
Tag description
SubTag description
_links object
{
"data": [
{
"id": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"organisationName": "string",
"partnerId": "string",
"configurationId": "string",
"validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"suggestedActivitySubTags": [
{
"id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Sport school",
"tag": {
"id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Education",
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
},
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
}
],
"status": "live",
"results": {
"eligibilityStatus": "fail",
"confirmedActivitySubTags": [
{
"id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Sport school",
"tag": {
"id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Education",
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
},
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
}
],
"rejectedActivitySubTags": [
{
"id": "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Sport school",
"tag": {
"id": "activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Education",
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
},
"description": "string",
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
}
]
},
"createdAt": "2020-10-13T17:46:54.000Z",
"updatedAt": "2020-10-13T17:46:54.000Z"
}
],
"object": "eligibility_subscription",
"totalResults": 33,
"pageSize": 25,
"_links": {
"current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- IncorrectParams
- CursorError
Schema
error object
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Error in cursor parameter
{
"error": {
"code": "pagination/cursor_error",
"title": "Bad request",
"message": "Unable to find the next page"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}