List Eligibility Subscriptions

GET 
/v1/eligibility-subscriptions

List Eligibility Subscriptions

Request

Query Parameters

sort string

Possible values: [id]

Field to sort

query string
status string

Possible values: [pending_validation_request, validation_request_failed, pending, live, cancelled, cannot_define_eligibility]

startDate date-time
Start date to retrieve monitoring from.
Example: 2020-10-13T17:46:54.000Z
endDate date-time
hasOrganisation boolean

Filter eligibility subscriptions based on whether there is a recognised Organisation tied to the subscription

cursor string

A cursor that points to where to start the page

pageSize integer
How many items per page, for pagination.
Default value: 25
direction string

Possible values: [ASC, DESC]

Which way to sort by the given 'sort' field. Default DESC

Responses

200

Successfully retrieved a page of Eligibility Subscriptions

application/json

Schema

Schema

data

object[]

Array [

idstring

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationNamestringnullable

partnerIdstring

configurationIdstring

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

suggestedActivitySubTags

object[]

nullable

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

statusstring

Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled, cannot_define_eligibility]

Example: live

results

object

eligibilityStatusstringnullable

Possible values: [pass, fail]

Example: fail

confirmedActivitySubTags

object[]

nullable

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

rejectedActivitySubTags

object[]

nullable

Confirmed organisation's activity subtags that are not allowed in partner's configuration

Array [

idstring

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

SubTag name

Example: Sport school

tag

object

idstring

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Tag name

Example: Education

descriptionstringnullable

Tag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

descriptionstringnullable

SubTag description

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

updatedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

]

objectstring
Example: eligibility_subscription
totalResultsinteger
Example: 33
pageSizeinteger
Example: 25

_links

object

currentstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

nextstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

prevstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

Example (from schema)

{
  "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"
  }
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

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"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}