Retrieve an single Eligibility Subscription
GET/v1/eligibility-subscriptions/:id
Retrieve an single Eligibility Subscription
Request​
Path Parameters
id stringrequired
Id of the Eligibility Subscription.
Responses​
- 200
- 400
- 401
- 403
- 404
Successfully retrieved an Eligibility Subscription
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
data object
id string
organisationId stringnullable
organisationName stringnullable
partnerId string
configurationId string
validationRequestId stringnullable
suggestedActivitySubTags object[]nullable
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
status string
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
, cannot_define_eligibility
]
results object
eligibilityStatus stringnullable
Possible values: [pass
, fail
]
confirmedActivitySubTags object[]nullable
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
rejectedActivitySubTags object[]nullable
Confirmed organisation's activity subtags that are not allowed in partner's configuration
id string
name string
SubTag name
tag object
id string
name string
Tag name
description stringnullable
Tag description
createdAt date-time
updatedAt date-timenullable
description stringnullable
SubTag description
createdAt date-time
updatedAt date-timenullable
createdAt date-time
updatedAt date-timenullable
object string
{
"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"
}
Error validating inputs
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
reasons string[]
{
"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"
]
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
The specified resource was not found
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "not_found",
"title": "Resource not found",
"message": "This endpoint is unavailable or can not be found"
}
}
Loading...