Providers
Download SpecGet Tpp Categories
ApiKey
Response
Successful Response
{}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Not found
Empty response
Enable Provider
Adds a Provider to the Marketplace. The provider must first be pre-approved.
tpp_id
string
cp_deployment_id
string
required
enable
boolean
required
product_type
required
An enumeration.
ApiKey
Adds a Provider to the Marketplace. The provider must first be pre-approved.
Request
{
"tpp_id": "string",
"cp_deployment_id": "string",
"enable": true,
"product_type": null
}
Response
Successful Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
Create Or Update Provider Customer
Using the id of one your Partner
customers, create an entry on the given provider user table.
meta
object (meta)
first_name
string
surname
string
preferred_name
string
dob
string
date-time
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
string
date-time
partner_surname
string
partner_sex
string
relationship_to_partner
string
smoker
string
number_of_cigarettes_per_week
int
drinker
string
number_of_units_per_week
int
national_insurance_number
string
passport_number
string
phone_number
string
mobile_number
string
last_visited
string
date-time
visits
int
terms_conditions
boolean
associated_cp_user
string
string
id
string
user_id
string
tpp_id
string
required
ApiKey
Using the id of one your Partner
customers, create an entry on the given provider user table.
Request
{
"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
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"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
meta
object (meta)
first_name
string
surname
string
preferred_name
string
dob
string
date-time
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
string
date-time
partner_surname
string
partner_sex
string
relationship_to_partner
string
smoker
string
number_of_cigarettes_per_week
int
drinker
string
number_of_units_per_week
int
national_insurance_number
string
passport_number
string
phone_number
string
mobile_number
string
last_visited
string
date-time
visits
int
terms_conditions
boolean
associated_cp_user
string
string
id
string
user_id
string
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
tpp_id
string
required
ApiKey
Gets a sinlge Provider
Response
Successful Response
{
"id": "string",
"name": "string",
"description": "string",
"configuration": {},
"premium": 123,
"rating": 123.0,
"meta": {},
"type": "string",
"tier_level": 123,
"api_key": "string"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
id
string
required
name
string
required
description
string
required
configuration
object (configuration)
required
premium
int
rating
number
meta
object (meta)
type
string
tier_level
int
api_key
string
required
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
Was this page helpful?