Providers

get

Get Tpp Categories

API Key ApiKey

X-API-Key found in header

Responses

Response examples

Successful Response

{}
post

Enable Provider

Adds a Provider to the Marketplace. The provider must first be pre-approved.

tpp_idstring
cp_deployment_idstring

required

enableboolean

required

product_type

required

An enumeration.

Responses

Request examples

{
  "tpp_id": "string",
  "cp_deployment_id": "string",
  "enable": true,
  "product_type": null
}

Response examples

Successful Response

Empty response

post

Create Or Update Provider Customer

Using the id of one your Partner customers, create an entry on the given provider user table.

metaobject (Meta)
first_namestring
surnamestring
preferred_namestring
dobstring
Format
date-time
titlestring
postcodestring
building_numberstring
address_1string
address_2string
address_3string
town_citystring
countystring
country_of_residencestring
nationalitystring
genderstring
relationship_statusstring
number_of_childrenstring
ages_of_childrenstring
partner_first_namestring
partner_dobstring
Format
date-time
partner_surnamestring
partner_sexstring
relationship_to_partnerstring
smokerstring
number_of_cigarettes_per_weekint
drinkerstring
number_of_units_per_weekint
national_insurance_numberstring
passport_numberstring
phone_numberstring
mobile_numberstring
last_visitedstring
Format
date-time
visitsint
terms_conditionsboolean
associated_cp_userstring
emailstring
Format
email
idstring
user_idstring

Responses

Request examples

{
  "meta": {},
  "first_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "dob": "2023-06-07T17:32:28Z",
  "title": "string",
  "postcode": "string",
  "building_number": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "town_city": "string",
  "county": "string",
  "country_of_residence": "string",
  "nationality": "string",
  "gender": "string",
  "relationship_status": "string",
  "number_of_children": "string",
  "ages_of_children": "string",
  "partner_first_name": "string",
  "partner_dob": "2023-06-07T17:32:28Z",
  "partner_surname": "string",
  "partner_sex": "string",
  "relationship_to_partner": "string",
  "smoker": "string",
  "number_of_cigarettes_per_week": 123,
  "drinker": "string",
  "number_of_units_per_week": 123,
  "national_insurance_number": "string",
  "passport_number": "string",
  "phone_number": "string",
  "mobile_number": "string",
  "last_visited": "2023-06-07T17:32:28Z",
  "visits": 123,
  "terms_conditions": true,
  "associated_cp_user": "string",
  "email": "alice@example.com",
  "id": "string",
  "user_id": "string"
}

Response examples

Successful Response

{
  "meta": {},
  "first_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "dob": "2023-06-07T17:32:28Z",
  "title": "string",
  "postcode": "string",
  "building_number": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "town_city": "string",
  "county": "string",
  "country_of_residence": "string",
  "nationality": "string",
  "gender": "string",
  "relationship_status": "string",
  "number_of_children": "string",
  "ages_of_children": "string",
  "partner_first_name": "string",
  "partner_dob": "2023-06-07T17:32:28Z",
  "partner_surname": "string",
  "partner_sex": "string",
  "relationship_to_partner": "string",
  "smoker": "string",
  "number_of_cigarettes_per_week": 123,
  "drinker": "string",
  "number_of_units_per_week": 123,
  "national_insurance_number": "string",
  "passport_number": "string",
  "phone_number": "string",
  "mobile_number": "string",
  "last_visited": "2023-06-07T17:32:28Z",
  "visits": 123,
  "terms_conditions": true,
  "associated_cp_user": "string",
  "email": "alice@example.com",
  "id": "string",
  "user_id": "string"
}
get

Single Provider

Gets a sinlge Provider

tpp_idstring

required

Responses

Response examples

Successful Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "configuration": {},
  "premium": 123,
  "rating": 123.0,
  "meta": {},
  "type": "string",
  "tier_level": 123,
  "api_key": "string"
}

Was this page helpful?