Create an Eligibility Subscription

POST 
/v1/eligibility-subscriptions

Create an Eligibility Subscription

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

Body

required

oneOf

MOD1

organisationId stringrequired

suggestedActivitySubTags string[]nullable

MOD2

validationRequestId stringrequired

suggestedActivitySubTags string[]nullable

Responses

200

Successfully created a Eligibility Subscription

application/json

Schema

Schema

data

object

id string

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationId stringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationName stringnullable

partnerId string

configurationId string

validationRequestId stringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

suggestedActivitySubTags

object[]

nullable

Array [

id string

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

SubTag name

Example: Sport school

tag

object

id string

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

Tag name

Example: Education

description stringnullable

Tag description

createdAt date-time

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

updatedAt date-timenullable

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

description stringnullable

SubTag description

createdAt date-time

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

updatedAt date-timenullable

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

]

status string

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

Example: live

results

object

eligibilityStatus stringnullable

Possible values: [pass, fail]

Example: fail

confirmedActivitySubTags

object[]

nullable

Array [

id string

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

SubTag name

Example: Sport school

tag

object

id string

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

Tag name

Example: Education

description stringnullable

Tag description

createdAt date-time

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

updatedAt date-timenullable

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

description stringnullable

SubTag description

createdAt date-time

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

updatedAt date-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 [

id string

Example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

SubTag name

Example: Sport school

tag

object

id string

Example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

Tag name

Example: Education

description stringnullable

Tag description

createdAt date-time

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

updatedAt date-timenullable

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

description stringnullable

SubTag description

createdAt date-time

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

updatedAt date-timenullable

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

]

createdAt date-time

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

updatedAt date-timenullable

Example: 2020-10-13T17:46:54.000Z
object string
Example: eligibility_subscription

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

400

Bad request

application/json

Schema

Schema

error

object

code string

title string

message string

reasons string[]nullable

Example (from schema)

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

EntityNotFound

Subscription Entity Not Found

{
  "error": {
    "code": "eligibility_subscription/entity_not_found",
    "title": "Bad request",
    "message": "Organisation or validation request was not found"
  }
}

OrganisationNotActive

400 Bad request

{
  "error": {
    "code": "eligibility_subscription/organisation_not_active",
    "title": "Bad request",
    "message": "Organisation is not active"
  }
}

InvalidSubTags

400 Bad request

{
  "error": {
    "code": "eligibility_subscription/invalid_sub_tags",
    "title": "Bad request",
    "message": "At least one of provided suggested subtags is invalid"
  }
}

BadRequest

400 Bad Request

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "Something is wrong with your request, please check any parameters and try again"
  }
}

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

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

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

Loading...