API structure has changed
27 structure changes including:
1 Breaking change
21 Additions
5 Modifications
1 Removal
Modified
5
Breaking
PUT /api/v1/plans/{uuid}
- Body
-
content type Modified
- term, maturity_date, is_trust properties Removed
- agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, review_date, on_panel, active_adviser_uuid, linked_plans, platform_provider, life_assured, sum_assured, term_type, term_maturity_date, term_age, term_maturity_value, guaranteed_term, payment_type, income_amount, income_frequency, income_from, income_escalation, address_1, address_2, address_3, address_4, town_city, county, postcode, country, new_property, price_listed, purchase_price, asset_description, ncd, ncd_protected, ncd_years, renewal_date, offshore, in_trust, original_balance, outstanding_balance, property_type, initial_payment, loan_quote, loan_type, mig_added, mig_premium, repayment_method, repayment_term, other_repayment_method, scheme_fixed_date, transaction_details, base_payment, has_transfer_penalties, is_portable_mortgage, transfer_consent, transfer_penalty, contract_exchanged, date_complete, date_confirmed, date_exchanged, date_submitted, mortgage_completed, offer_confirmed, offer_confirmed_date, offer_date, offer_issued, on_risk, proposal_date, submitted, declined_notes, plan_retirement_age, state_retirement_age, salary_sacrifice, waiver, is_crystallised, crystallisation_amount, crystallisation_benefit, crystallisation_fund, crystallisation_start_date, crystallisation_end_date, crystallisation_frequency, fund_amount, uncrystallised_fund, income_taken_amount, maximum_income_amount, tax_free_amount, lifetime_allowance_percentage, lta_applied, mpaa_trigger, pcls_percentage, reason, has_pre_existing_conditions, pre_existing_conditions_notes properties Added
- Response
-
200 response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
POST /api/v1/plans
- Body
-
content type Modified
- term, maturity_date, is_trust properties Removed
- agency_in_your_name, agency_in_your_name_from, originally_sold_by_firm, under_advice, visible_on_client_portal, include_in_client_valuation, review_date, on_panel, active_adviser_uuid, platform_provider, life_assured, sum_assured, term_type, term_maturity_date, term_age, term_maturity_value, guaranteed_term, payment_type, income_amount, income_frequency, income_from, income_escalation, address_1, address_2, address_3, address_4, town_city, county, postcode, country, new_property, price_listed, purchase_price, asset_description, ncd, ncd_protected, ncd_years, renewal_date, offshore, in_trust, original_balance, outstanding_balance, property_type, initial_payment, loan_quote, loan_type, mig_added, mig_premium, repayment_method, repayment_term, other_repayment_method, scheme_fixed_date, transaction_details, base_payment, has_transfer_penalties, is_portable_mortgage, transfer_consent, transfer_penalty, contract_exchanged, date_complete, date_confirmed, date_exchanged, date_submitted, mortgage_completed, offer_confirmed, offer_confirmed_date, offer_date, offer_issued, on_risk, proposal_date, submitted, declined_notes, plan_retirement_age, state_retirement_age, salary_sacrifice, waiver, is_crystallised, crystallisation_amount, crystallisation_benefit, crystallisation_fund, crystallisation_start_date, crystallisation_end_date, crystallisation_frequency, fund_amount, uncrystallised_fund, income_taken_amount, maximum_income_amount, tax_free_amount, lifetime_allowance_percentage, lta_applied, mpaa_trigger, pcls_percentage, reason, has_pre_existing_conditions, pre_existing_conditions_notes properties Added
- Response
-
200 response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (1) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (2) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (3) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (4) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (5) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (6) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (7) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (8) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
-
200 (9) response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
GET /api/v1/plans/{uuid}
- Response
-
200 response Modified
- provider property Modified
- covers, claims, total_benefit_amount, total_benefits, linked_plans properties Added
GET /api/v1/plans
- Query
- filter[active_adviser] query parameter Added
GET /api/v1/client/{client_uuid}/plans
- Query
- filter[abstract_type], filter[type], filter[name], filter[client], filter[policy_number], filter[provider], filter[status], filter[seller], filter[active_adviser], filter[case], filter[valuation_from], filter[valuation_to], filter[custom_field:REFERENCE] query parameters Added
Removed
1
Breaking
GET /api/v1/plans/inactivity-reasons
Added
21
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
POST /api/v1/plans/{plan_uuid}/cover
POST /api/v1/plans/{plan_uuid}/claim
GET /api/v1/static/transfer-froms
GET /api/v1/static/term-types
GET /api/v1/static/repayment-types
GET /api/v1/static/repayment-methods
GET /api/v1/static/property-types
GET /api/v1/static/plan-statuses
GET /api/v1/static/plan-inactivity-reasons
GET /api/v1/static/interest-types
GET /api/v1/static/crystallisation-reasons
GET /api/v1/static/cover-types/{type}
GET /api/v1/static/boolean-choices
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
GET /api/v1/plans/{plan_uuid}/cover
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
GET /api/v1/plans/{plan_uuid}/claim
DELETE /api/v1/plans/{plan_uuid}/cover/{uuid}
DELETE /api/v1/plans/{plan_uuid}/claim/{uuid}