Skip to main content

API releases — 2023

All API releases · How to read this history

20 October 2023 — Referrer models and relationship coverage​

  • Adds adviser web-public visibility and referrer organisation names. Contact-group referrer responses use the referrer-member document model.
  • Removes 24 generic relationship operations for asset classifications, enquiry sources, property types and referrers.
  • Updates relationship access annotations across shared resource models and changes the referrer resource type model.

Compatibility: Review referrer deserialisation, resource type values and removed generic relationship routes. Several relationships become write-only or disappear from response models.

308 operations after this release · 0 added · 24 removed · 4 updated. Schema changes are counted separately below.

Endpoint details

Removed

  • GET /jsonapi/asset-categories/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-categories/{id}/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/{relationshipName}
  • GET /jsonapi/asset-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-types/{id}/{relationshipName}
  • GET /jsonapi/enquiry-sources/{id}/relationships/{relationshipName}
  • GET /jsonapi/enquiry-sources/{id}/{relationshipName}
  • GET /jsonapi/property-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/property-types/{id}/{relationshipName}
  • GET /jsonapi/referrers/{id}/relationships/{relationshipName}
  • GET /jsonapi/referrers/{id}/{relationshipName}
  • HEAD /jsonapi/asset-categories/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-categories/{id}/{relationshipName}
  • HEAD /jsonapi/asset-sub-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-sub-types/{id}/{relationshipName}
  • HEAD /jsonapi/asset-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-types/{id}/{relationshipName}
  • HEAD /jsonapi/enquiry-sources/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/enquiry-sources/{id}/{relationshipName}
  • HEAD /jsonapi/property-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/property-types/{id}/{relationshipName}
  • HEAD /jsonapi/referrers/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/referrers/{id}/{relationshipName}

Updated definitions

  • GET /jsonapi/contact-groups/{id}/referrer
  • GET /jsonapi/contact-groups/{id}/relationships/referrer
  • HEAD /jsonapi/contact-groups/{id}/referrer
  • HEAD /jsonapi/contact-groups/{id}/relationships/referrer
Schema details — 13 added, 1 removed, 24 updated

Added schemas

  • EnquirySource
  • EnquirySourceAttributes
  • EnquirySourceDocument
  • EnquirySourceEntityType
  • EnquirySourceRelationships
  • EnquirySourcesDocument
  • ReferrerMember
  • ReferrerMemberAttributes
  • ReferrerMemberDocument
  • ReferrerMemberRelationships
  • ReferrerMembersDocument
  • ReferrerMembersEntityType
  • ReferrersEntityType

Removed schemas

  • ReferrerEntityType

Updated schemas and changed locations

  • AdviserAttributes: /properties/isBrokerWebPublic
  • AdviserRelationships: /properties/addresses/$ref, /properties/addresses/allOf, /properties/addresses/writeOnly
  • AgreementHolderRelationships: /properties/organisation
  • BusinessRelationships: /properties/employments/$ref, /properties/employments/allOf, /properties/employments/writeOnly
  • ContactAddressRelationships: /properties/contacts/$ref, /properties/contacts/allOf, /properties/contacts/writeOnly
  • ContactGroupRelationships: /properties/referrer/$ref, /properties/referrer/allOf, /properties/referrer/writeOnly, /properties/referrerOrganisation/$ref, /properties/referrerOrganisation/allOf, /properties/referrerOrganisation/writeOnly
  • ContactRelationships: /properties/contactAddress/$ref, /properties/contactAddress/allOf, /properties/contactAddress/writeOnly, /properties/employments/$ref, /properties/employments/allOf, /properties/employments/writeOnly
  • DealScenarioRelationships: /properties/highLevelSummary/$ref, /properties/highLevelSummary/allOf, /properties/highLevelSummary/writeOnly
  • DealStructureImportantDateRelationships: /properties/dealStructure/$ref, /properties/dealStructure/allOf, /properties/dealStructure/writeOnly
  • DealStructureRelationships: /properties/deal/$ref, /properties/deal/allOf, /properties/deal/writeOnly
  • ExpenseCategoryRelationships: /properties/expenseTypes/$ref, /properties/expenseTypes/allOf, /properties/expenseTypes/writeOnly
  • ExpenseTypeRelationships: /properties/expenseCategory/$ref, /properties/expenseCategory/allOf, /properties/expenseCategory/writeOnly
  • HighLevelSummaryRelationships: /properties/dealScenario/$ref, /properties/dealScenario/allOf, /properties/dealScenario/writeOnly
  • IncludedResource: /discriminator/mapping/enquiry-source, /discriminator/mapping/referrer, /discriminator/mapping/referrer-members, /discriminator/mapping/referrers
  • IncomeCategoryRelationships: /properties/incomeTypes/$ref, /properties/incomeTypes/allOf, /properties/incomeTypes/writeOnly
  • IncomeTypeRelationships: /properties/incomeCategory/$ref, /properties/incomeCategory/allOf, /properties/incomeCategory/writeOnly
  • LiabilityCategoryRelationships: /properties/liabilityTypes/$ref, /properties/liabilityTypes/allOf, /properties/liabilityTypes/writeOnly
  • LiabilityTypeRelationships: /properties/liabilityCategory/$ref, /properties/liabilityCategory/allOf, /properties/liabilityCategory/writeOnly
  • OrganisationRelationships: /properties/addresses/$ref, /properties/addresses/allOf, /properties/addresses/writeOnly, /properties/advisers
  • OwnerRelationships: /properties/asset/$ref, /properties/asset/allOf, /properties/asset/writeOnly, /properties/expense/$ref, /properties/expense/allOf, /properties/expense/writeOnly, /properties/income/$ref, /properties/income/allOf, /properties/income/writeOnly, /properties/liability/$ref, /properties/liability/allOf, /properties/liability/writeOnly
  • Referrer: /properties/type/$ref
  • ReferrerAttributes: /properties/referrerName/maxLength, /properties/referrerName/minLength, /properties/referrerName/readOnly, /properties/referrerOrganisationName
  • ReferrerOrganisationRelationships: /properties/contactGroups/$ref, /properties/contactGroups/allOf, /properties/contactGroups/writeOnly
  • ReferrerRelationships: /properties

20 June 2023 — Deal note writes and enquiry source lookups​

  • Restores six deal-note write operations, including note creation, update and deletion and the associated deal relationship writes.
  • Adds eight GET and HEAD operations for enquiry sources and their generic relationship routes.
  • Removes loanPurpose from the high-level summary schema.

Compatibility: High-level summary readers should no longer depend on loanPurpose in that model.

332 operations after this release · 14 added · 0 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Added

  • DELETE /jsonapi/deal-notes/{id}
  • DELETE /jsonapi/deal-notes/{id}/relationships/deal
  • GET /jsonapi/enquiry-sources
  • GET /jsonapi/enquiry-sources/{id}
  • GET /jsonapi/enquiry-sources/{id}/relationships/{relationshipName}
  • GET /jsonapi/enquiry-sources/{id}/{relationshipName}
  • HEAD /jsonapi/enquiry-sources
  • HEAD /jsonapi/enquiry-sources/{id}
  • HEAD /jsonapi/enquiry-sources/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/enquiry-sources/{id}/{relationshipName}
  • PATCH /jsonapi/deal-notes/{id}
  • PATCH /jsonapi/deal-notes/{id}/relationships/deal
  • POST /jsonapi/deal-notes
  • POST /jsonapi/deal-notes/{id}/relationships/deal
Schema details — 0 added, 0 removed, 1 updated

Updated schemas and changed locations

  • HighLevelSummaryAttributes: /properties/loanPurpose

4 May 2023 — Write operation availability​

  • Removes 69 write operations from the contract across contacts, contact groups, contact and deal external references, deal notes and integrations.
  • Read operations remain in the reference. Later releases restore selected write capabilities; consult the current endpoint reference when planning an integration.

Compatibility: Check any POST, PATCH or DELETE operation in these resource groups against the removed-operation list.

318 operations after this release · 0 added · 69 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Removed

  • DELETE /jsonapi/contact-external-references/{id}
  • DELETE /jsonapi/contact-external-references/{id}/relationships/contact
  • DELETE /jsonapi/contact-external-references/{id}/relationships/integration
  • DELETE /jsonapi/contact-groups/{id}
  • DELETE /jsonapi/contact-groups/{id}/relationships/adviser
  • DELETE /jsonapi/contact-groups/{id}/relationships/businesses
  • DELETE /jsonapi/contact-groups/{id}/relationships/contacts
  • DELETE /jsonapi/contact-groups/{id}/relationships/referrer
  • DELETE /jsonapi/contact-groups/{id}/relationships/referrerOrganisation
  • DELETE /jsonapi/contacts/{id}
  • DELETE /jsonapi/contacts/{id}/relationships/contactAddress
  • DELETE /jsonapi/contacts/{id}/relationships/contactGroup
  • DELETE /jsonapi/contacts/{id}/relationships/deals
  • DELETE /jsonapi/contacts/{id}/relationships/externalReferences
  • DELETE /jsonapi/contacts/{id}/relationships/ownership
  • DELETE /jsonapi/deal-external-references/{id}
  • DELETE /jsonapi/deal-external-references/{id}/relationships/deal
  • DELETE /jsonapi/deal-external-references/{id}/relationships/integration
  • DELETE /jsonapi/deal-notes/{id}
  • DELETE /jsonapi/deal-notes/{id}/relationships/deal
  • DELETE /jsonapi/integrations/{id}
  • DELETE /jsonapi/integrations/{id}/relationships/contactExternalReferences
  • DELETE /jsonapi/integrations/{id}/relationships/dealExternalReferences
  • PATCH /jsonapi/contact-external-references/{id}
  • PATCH /jsonapi/contact-external-references/{id}/relationships/contact
  • PATCH /jsonapi/contact-external-references/{id}/relationships/integration
  • PATCH /jsonapi/contact-groups/{id}
  • PATCH /jsonapi/contact-groups/{id}/relationships/adviser
  • PATCH /jsonapi/contact-groups/{id}/relationships/businesses
  • PATCH /jsonapi/contact-groups/{id}/relationships/contacts
  • PATCH /jsonapi/contact-groups/{id}/relationships/referrer
  • PATCH /jsonapi/contact-groups/{id}/relationships/referrerOrganisation
  • PATCH /jsonapi/contacts/{id}
  • PATCH /jsonapi/contacts/{id}/relationships/contactAddress
  • PATCH /jsonapi/contacts/{id}/relationships/contactGroup
  • PATCH /jsonapi/contacts/{id}/relationships/deals
  • PATCH /jsonapi/contacts/{id}/relationships/externalReferences
  • PATCH /jsonapi/contacts/{id}/relationships/ownership
  • PATCH /jsonapi/deal-external-references/{id}
  • PATCH /jsonapi/deal-external-references/{id}/relationships/deal
  • PATCH /jsonapi/deal-external-references/{id}/relationships/integration
  • PATCH /jsonapi/deal-notes/{id}
  • PATCH /jsonapi/deal-notes/{id}/relationships/deal
  • PATCH /jsonapi/integrations/{id}
  • PATCH /jsonapi/integrations/{id}/relationships/contactExternalReferences
  • PATCH /jsonapi/integrations/{id}/relationships/dealExternalReferences
  • POST /jsonapi/contact-external-references
  • POST /jsonapi/contact-external-references/{id}/relationships/contact
  • POST /jsonapi/contact-external-references/{id}/relationships/integration
  • POST /jsonapi/contact-groups
  • POST /jsonapi/contact-groups/{id}/relationships/adviser
  • POST /jsonapi/contact-groups/{id}/relationships/businesses
  • POST /jsonapi/contact-groups/{id}/relationships/contacts
  • POST /jsonapi/contact-groups/{id}/relationships/referrer
  • POST /jsonapi/contact-groups/{id}/relationships/referrerOrganisation
  • POST /jsonapi/contacts
  • POST /jsonapi/contacts/{id}/relationships/contactAddress
  • POST /jsonapi/contacts/{id}/relationships/contactGroup
  • POST /jsonapi/contacts/{id}/relationships/deals
  • POST /jsonapi/contacts/{id}/relationships/externalReferences
  • POST /jsonapi/contacts/{id}/relationships/ownership
  • POST /jsonapi/deal-external-references
  • POST /jsonapi/deal-external-references/{id}/relationships/deal
  • POST /jsonapi/deal-external-references/{id}/relationships/integration
  • POST /jsonapi/deal-notes
  • POST /jsonapi/deal-notes/{id}/relationships/deal
  • POST /jsonapi/integrations
  • POST /jsonapi/integrations/{id}/relationships/contactExternalReferences
  • POST /jsonapi/integrations/{id}/relationships/dealExternalReferences