MMOB
Environment:
MMOB
Environment:

Providers

Download Spec

Get Tpp Categories

get /tpp/categories

Authentication

API Key ApiKey

X-API-Key found in header

Responses

Response: application/json

Enable Provider

post /tpp/enable

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

Authentication

API Key ApiKey

X-API-Key found in header

application/json

cp_deployment_id

string

required

enable

boolean

required

product_type

required

An enumeration.

tpp_id

string

Responses

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Create Or Update Provider Customer

post /tpp/{tpp_id}/customer

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

Authentication

API Key ApiKey

X-API-Key found in header

tpp_id

string

required

application/json

address_1

string

address_2

string

address_3

string

ages_of_children

string

associated_cp_user

string

building_number

string

country_of_residence

string

county

string

dob

string

date-time

drinker

string

email

string

email

first_name

string

gender

string

id

string

last_visited

string

date-time

meta

object (meta)

mobile_number

string

national_insurance_number

string

nationality

string

number_of_children

string

number_of_cigarettes_per_week

int

number_of_units_per_week

int

partner_dob

string

date-time

partner_first_name

string

partner_sex

string

partner_surname

string

passport_number

string

phone_number

string

postcode

string

preferred_name

string

relationship_status

string

relationship_to_partner

string

smoker

string

surname

string

terms_conditions

boolean

title

string

town_city

string

user_id

string

visits

int

Responses

Response: application/json

address_1

string

address_2

string

address_3

string

ages_of_children

string

associated_cp_user

string

building_number

string

country_of_residence

string

county

string

dob

string

date-time

drinker

string

email

string

email

first_name

string

gender

string

id

string

last_visited

string

date-time

meta

object (meta)

mobile_number

string

national_insurance_number

string

nationality

string

number_of_children

string

number_of_cigarettes_per_week

int

number_of_units_per_week

int

partner_dob

string

date-time

partner_first_name

string

partner_sex

string

partner_surname

string

passport_number

string

phone_number

string

postcode

string

preferred_name

string

relationship_status

string

relationship_to_partner

string

smoker

string

surname

string

terms_conditions

boolean

title

string

town_city

string

user_id

string

visits

int

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Single Provider

get /tpp/{tpp_id}

Gets a sinlge Provider

Authentication

API Key ApiKey

X-API-Key found in header

tpp_id

string

required

Responses

Response: application/json

api_key

string

required

configuration

object (configuration)

required

description

string

required

id

string

required

meta

object (meta)

name

string

required

premium

int

rating

number

tier_level

int

type

string

Response: application/json

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?