{ "formatVersion": 1, "title": "MyCRM API releases", "source": { "repository": "mycrm-api-docs", "file": "swagger.json", "commit": "ac4a42b1ddc284fdf50102de33ad6b91f4fbc73f", "traversal": "first-parent", "dateBasis": "Historical main-branch commit dates; new specification updates use the release date supplied for review" }, "comparison": "Each revision is compared with the preceding main-branch OpenAPI Specification revision. Method/path pairs count separately, including HEAD. Changed operations include descriptions and shared path settings. Schema changes are listed separately. JSON changes retain exact before/after values; the baseline is available at its source commit.", "releases": [ { "commit": "cb7e7300a2b27aa4fad01fc44acd5d1e216ba151", "committedAt": "2022-02-09T16:52:10+10:00", "date": "2022-02-09", "title": "Initial API reference", "highlights": [ "The first preserved API contract covers leads and structured leads, contacts and contact groups, deals and notes, advisers and organisations, and financial resources.", "Use this snapshot as the starting point for the release history. It does not establish when these capabilities were first introduced." ], "swaggerSha256": "ece6dc4105415df957a99af2282c53d1872f3a36978d5ec489adca1d860e3d50", "counts": { "operations": 374, "paths": 121, "schemas": 281 }, "baseline": true }, { "commit": "a80ff2e3e0367189b901fe0c3a034e948c96d2d0", "committedAt": "2022-02-09T17:04:28+10:00", "date": "2022-02-09", "title": "API naming refinement", "highlights": [ "The specification title becomes “MyCRM API”. Endpoint definitions and schemas are unchanged." ], "swaggerSha256": "aa42fe94fc1c5bffb5b916d6086fea3a619410a15ecf36d5dbd2a36aab68f214", "counts": { "operations": 374, "paths": 121, "schemas": 281 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [] }, "changes": [ { "kind": "changed", "path": "/info/title", "before": "MyCRM JsonApi", "after": "MyCRM API" } ] }, { "commit": "92e56fd0cc63cd57ee08d50818f4a7f0ebec1f22", "committedAt": "2022-02-14T16:17:47+10:00", "date": "2022-02-14", "title": "Asset classification lookups", "highlights": [ "Adds collection and individual-record GET and HEAD operations for asset categories, asset types and asset sub-types.", "Asset details gain classification identifiers. Structured lead asset schemas use `assetTypeId` and `assetSubTypeId` in place of the earlier enum fields." ], "compatibility": "Review clients that populated the former asset type and sub-type enum fields.", "swaggerSha256": "6e750a63dd80e9312a13eea1b6d5c925b421281a3de42f13ea9f533fc6998724", "counts": { "operations": 386, "paths": 127, "schemas": 297 }, "operations": { "added": [ "GET /jsonapi/asset-categories", "GET /jsonapi/asset-categories/{id}", "GET /jsonapi/asset-sub-types", "GET /jsonapi/asset-sub-types/{id}", "GET /jsonapi/asset-types", "GET /jsonapi/asset-types/{id}", "HEAD /jsonapi/asset-categories", "HEAD /jsonapi/asset-categories/{id}", "HEAD /jsonapi/asset-sub-types", "HEAD /jsonapi/asset-sub-types/{id}", "HEAD /jsonapi/asset-types", "HEAD /jsonapi/asset-types/{id}" ], "removed": [], "changed": [] }, "schemas": { "added": [ "AssetCategoriesDocument", "AssetCategoriesEntityType", "AssetCategory", "AssetCategoryAttributes", "AssetCategoryDocument", "AssetCategoryRelationships", "AssetSubTypeAttributes", "AssetSubTypeDocument", "AssetSubTypeRelationships", "AssetSubTypesDocument", "AssetSubTypesEntityType", "AssetTypeAttributes", "AssetTypeDocument", "AssetTypeRelationships", "AssetTypesDocument", "AssetTypesEntityType" ], "removed": [], "changed": [ "AssetAttributes", "AssetSubType", "AssetType", "IncludedResource", "LeadAsset" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AssetAttributes/properties/assetCategory", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AssetAttributes/properties/assetCategoryId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AssetAttributes/properties/assetSubTypeId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AssetAttributes/properties/assetTypeId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AssetCategoriesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetCategoriesEntityType", "after": { "enum": [ "asset-categories" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/AssetCategory", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AssetCategoryAttributes", "after": { "type": "object", "properties": { "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetCategoryDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetCategoryRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AssetSubType/additionalProperties", "after": false }, { "kind": "added", "path": "/components/schemas/AssetSubType/allOf", "after": [ { "$ref": "#/components/schemas/IncludedResource" } ] }, { "kind": "removed", "path": "/components/schemas/AssetSubType/enum", "before": [ "Item4WD", "Bike", "Large", "LuxuryCar", "Medium", "Small", "SmallMedium" ] }, { "kind": "added", "path": "/components/schemas/AssetSubType/properties", "after": { "type": { "$ref": "#/components/schemas/AssetSubTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetSubTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetSubTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } } }, { "kind": "added", "path": "/components/schemas/AssetSubType/required", "after": [ "type", "id" ] }, { "kind": "changed", "path": "/components/schemas/AssetSubType/type", "before": "string", "after": "object" }, { "kind": "removed", "path": "/components/schemas/AssetSubType/x-ms-enum", "before": { "name": "AssetSubType", "modelAsString": true } }, { "kind": "added", "path": "/components/schemas/AssetSubTypeAttributes", "after": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetSubTypeDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetSubType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetSubTypeRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AssetSubTypesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetSubType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetSubTypesEntityType", "after": { "enum": [ "asset-sub-types" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/AssetType/additionalProperties", "after": false }, { "kind": "added", "path": "/components/schemas/AssetType/allOf", "after": [ { "$ref": "#/components/schemas/IncludedResource" } ] }, { "kind": "removed", "path": "/components/schemas/AssetType/enum", "before": [ "RealEstate", "Boat", "Bonds", "Cash", "CashManagement", "ChargeOverCash", "ChequeAccount", "Collections", "DebentureCharge", "Furniture", "Gifts", "Goodwill", "Guarantee", "HomeContents", "Savings", "LifeInsurance", "ManagedFunds", "MotorVehicle", "Other", "OtherDeposit", "PensionAccount", "Equity", "Receivables", "SavingsAccount", "Shares", "StockAndMachinery", "Superannuation", "TermDeposit", "TimeShare", "ToolsOfTrade", "DepositPaid", "Kiwisaver", "Art", "BusinessEquity", "Commercial", "FamilyLoanbeingRepaid", "Jewellery" ] }, { "kind": "added", "path": "/components/schemas/AssetType/properties", "after": { "type": { "$ref": "#/components/schemas/AssetTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } } }, { "kind": "added", "path": "/components/schemas/AssetType/required", "after": [ "type", "id" ] }, { "kind": "changed", "path": "/components/schemas/AssetType/type", "before": "string", "after": "object" }, { "kind": "removed", "path": "/components/schemas/AssetType/x-ms-enum", "before": { "name": "AssetType", "modelAsString": true } }, { "kind": "added", "path": "/components/schemas/AssetTypeAttributes", "after": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetTypeDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetTypeRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AssetTypesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetTypesEntityType", "after": { "enum": [ "asset-types" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/asset-categories", "after": "#/components/schemas/AssetCategory" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/asset-sub-types", "after": "#/components/schemas/AssetSubType" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/asset-types", "after": "#/components/schemas/AssetType" }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/assetSubType", "before": { "$ref": "#/components/schemas/AssetSubType" } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/assetSubTypeId", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/assetType", "before": { "$ref": "#/components/schemas/AssetType" } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/assetTypeId", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories", "after": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets a collection of asset categories", "operationId": "AssetCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategories_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}", "after": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets a single asset category by id", "description": "Where `id` is the identifier of the asset category", "operationId": "AssetCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types", "after": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets a collection of asset sub-types", "operationId": "AssetSubTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetSubTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypes_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}", "after": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets a single asset sub-type by id", "description": "Where `id` is the identifier of the asset sub-type", "operationId": "AssetSubType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetSubTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types", "after": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets a collection of asset types", "operationId": "AssetTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypes_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}", "after": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets a single asset type by id", "description": "Where `id` is the identifier of the asset type", "operationId": "AssetType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "c2faa5ef5c6d7d11edf56459d462cdfcd9ff760c", "committedAt": "2022-02-15T17:34:32+10:00", "date": "2022-02-15", "title": "Directory coverage and supported operations", "highlights": [ "Expands adviser, adviser-detail, organisation and referrer coverage, along with related-resource and relationship lookup routes.", "Removes write operations for assets, deals, deal participants, expenses, incomes and liabilities from the contract, and removes the contact-group-referrer routes." ], "compatibility": "This revision adds 76 operations and removes 83. Check the endpoint list below if your integration used one of the removed operations.", "swaggerSha256": "0ef6f30dae08df3e52ee0760220763fdab6e2bccb4cf546f06420424aefe1da2", "counts": { "operations": 379, "paths": 157, "schemas": 291 }, "operations": { "added": [ "GET /jsonapi/advisers/{id}/addresses", "GET /jsonapi/advisers/{id}/adviserDetails", "GET /jsonapi/advisers/{id}/agreementHolders", "GET /jsonapi/advisers/{id}/contactGroups", "GET /jsonapi/advisers/{id}/organisation", "GET /jsonapi/advisers/{id}/relationships/addresses", "GET /jsonapi/advisers/{id}/relationships/adviserDetails", "GET /jsonapi/advisers/{id}/relationships/agreementHolders", "GET /jsonapi/advisers/{id}/relationships/contactGroups", "GET /jsonapi/advisers/{id}/relationships/organisation", "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/expense-categories/{id}/expenseTypes", "GET /jsonapi/expense-categories/{id}/relationships/expenseTypes", "GET /jsonapi/expense-types/{id}/expenseCategory", "GET /jsonapi/expense-types/{id}/relationships/expenseCategory", "GET /jsonapi/income-categories/{id}/incomeTypes", "GET /jsonapi/income-categories/{id}/relationships/incomeTypes", "GET /jsonapi/income-types/{id}/incomeCategory", "GET /jsonapi/income-types/{id}/relationships/incomeCategory", "GET /jsonapi/liability-categories/{id}/liabilityTypes", "GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes", "GET /jsonapi/liability-types/{id}/liabilityCategory", "GET /jsonapi/liability-types/{id}/relationships/liabilityCategory", "GET /jsonapi/organisations/{id}/addresses", "GET /jsonapi/organisations/{id}/relationships/addresses", "GET /jsonapi/referrers", "GET /jsonapi/referrers/{id}", "GET /jsonapi/referrers/{id}/relationships/{relationshipName}", "GET /jsonapi/referrers/{id}/{relationshipName}", "HEAD /jsonapi/adviser-details", "HEAD /jsonapi/adviser-details/{id}", "HEAD /jsonapi/adviser-details/{id}/adviser", "HEAD /jsonapi/adviser-details/{id}/relationships/adviser", "HEAD /jsonapi/advisers", "HEAD /jsonapi/advisers/{id}", "HEAD /jsonapi/advisers/{id}/addresses", "HEAD /jsonapi/advisers/{id}/adviserDetails", "HEAD /jsonapi/advisers/{id}/agreementHolders", "HEAD /jsonapi/advisers/{id}/contactGroups", "HEAD /jsonapi/advisers/{id}/organisation", "HEAD /jsonapi/advisers/{id}/relationships/addresses", "HEAD /jsonapi/advisers/{id}/relationships/adviserDetails", "HEAD /jsonapi/advisers/{id}/relationships/agreementHolders", "HEAD /jsonapi/advisers/{id}/relationships/contactGroups", "HEAD /jsonapi/advisers/{id}/relationships/organisation", "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/expense-categories/{id}/expenseTypes", "HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes", "HEAD /jsonapi/expense-types/{id}/expenseCategory", "HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory", "HEAD /jsonapi/income-categories/{id}/incomeTypes", "HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes", "HEAD /jsonapi/income-types/{id}/incomeCategory", "HEAD /jsonapi/income-types/{id}/relationships/incomeCategory", "HEAD /jsonapi/liability-categories/{id}/liabilityTypes", "HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes", "HEAD /jsonapi/liability-types/{id}/liabilityCategory", "HEAD /jsonapi/liability-types/{id}/relationships/liabilityCategory", "HEAD /jsonapi/organisations", "HEAD /jsonapi/organisations/{id}", "HEAD /jsonapi/organisations/{id}/addresses", "HEAD /jsonapi/organisations/{id}/relationships/addresses", "HEAD /jsonapi/referrers", "HEAD /jsonapi/referrers/{id}", "HEAD /jsonapi/referrers/{id}/relationships/{relationshipName}", "HEAD /jsonapi/referrers/{id}/{relationshipName}" ], "removed": [ "DELETE /jsonapi/assets/{id}", "DELETE /jsonapi/assets/{id}/relationships/addresses", "DELETE /jsonapi/assets/{id}/relationships/ownership", "DELETE /jsonapi/contact-group-referrers/{id}", "DELETE /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}", "DELETE /jsonapi/deal-participants/{id}", "DELETE /jsonapi/deal-participants/{id}/relationships/contact", "DELETE /jsonapi/deal-participants/{id}/relationships/deal", "DELETE /jsonapi/deals/{id}", "DELETE /jsonapi/deals/{id}/relationships/adviser", "DELETE /jsonapi/deals/{id}/relationships/contacts", "DELETE /jsonapi/deals/{id}/relationships/dealNotes", "DELETE /jsonapi/deals/{id}/relationships/dealScenario", "DELETE /jsonapi/deals/{id}/relationships/dealStructures", "DELETE /jsonapi/deals/{id}/relationships/externalReferences", "DELETE /jsonapi/deals/{id}/relationships/importantDates", "DELETE /jsonapi/deals/{id}/relationships/participants", "DELETE /jsonapi/expenses/{id}", "DELETE /jsonapi/expenses/{id}/relationships/ownership", "DELETE /jsonapi/incomes/{id}", "DELETE /jsonapi/incomes/{id}/relationships/linkedAsset", "DELETE /jsonapi/incomes/{id}/relationships/ownership", "DELETE /jsonapi/liabilities/{id}", "DELETE /jsonapi/liabilities/{id}/relationships/linkedAsset", "DELETE /jsonapi/liabilities/{id}/relationships/ownership", "GET /jsonapi/contact-group-referrers", "GET /jsonapi/contact-group-referrers/{id}", "GET /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}", "GET /jsonapi/contact-group-referrers/{id}/{relationshipName}", "HEAD /jsonapi/contact-group-referrers", "HEAD /jsonapi/contact-group-referrers/{id}", "HEAD /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}", "HEAD /jsonapi/contact-group-referrers/{id}/{relationshipName}", "PATCH /jsonapi/assets/{id}", "PATCH /jsonapi/assets/{id}/relationships/addresses", "PATCH /jsonapi/assets/{id}/relationships/ownership", "PATCH /jsonapi/contact-group-referrers/{id}", "PATCH /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}", "PATCH /jsonapi/deal-participants/{id}", "PATCH /jsonapi/deal-participants/{id}/relationships/contact", "PATCH /jsonapi/deal-participants/{id}/relationships/deal", "PATCH /jsonapi/deals/{id}", "PATCH /jsonapi/deals/{id}/relationships/adviser", "PATCH /jsonapi/deals/{id}/relationships/contacts", "PATCH /jsonapi/deals/{id}/relationships/dealNotes", "PATCH /jsonapi/deals/{id}/relationships/dealScenario", "PATCH /jsonapi/deals/{id}/relationships/dealStructures", "PATCH /jsonapi/deals/{id}/relationships/externalReferences", "PATCH /jsonapi/deals/{id}/relationships/importantDates", "PATCH /jsonapi/deals/{id}/relationships/participants", "PATCH /jsonapi/expenses/{id}", "PATCH /jsonapi/expenses/{id}/relationships/ownership", "PATCH /jsonapi/incomes/{id}", "PATCH /jsonapi/incomes/{id}/relationships/linkedAsset", "PATCH /jsonapi/incomes/{id}/relationships/ownership", "PATCH /jsonapi/liabilities/{id}", "PATCH /jsonapi/liabilities/{id}/relationships/linkedAsset", "PATCH /jsonapi/liabilities/{id}/relationships/ownership", "POST /jsonapi/assets", "POST /jsonapi/assets/{id}/relationships/addresses", "POST /jsonapi/assets/{id}/relationships/ownership", "POST /jsonapi/contact-group-referrers", "POST /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}", "POST /jsonapi/deal-participants", "POST /jsonapi/deal-participants/{id}/relationships/contact", "POST /jsonapi/deal-participants/{id}/relationships/deal", "POST /jsonapi/deals", "POST /jsonapi/deals/{id}/relationships/adviser", "POST /jsonapi/deals/{id}/relationships/contacts", "POST /jsonapi/deals/{id}/relationships/dealNotes", "POST /jsonapi/deals/{id}/relationships/dealScenario", "POST /jsonapi/deals/{id}/relationships/dealStructures", "POST /jsonapi/deals/{id}/relationships/externalReferences", "POST /jsonapi/deals/{id}/relationships/importantDates", "POST /jsonapi/deals/{id}/relationships/participants", "POST /jsonapi/expenses", "POST /jsonapi/expenses/{id}/relationships/ownership", "POST /jsonapi/incomes", "POST /jsonapi/incomes/{id}/relationships/linkedAsset", "POST /jsonapi/incomes/{id}/relationships/ownership", "POST /jsonapi/liabilities", "POST /jsonapi/liabilities/{id}/relationships/linkedAsset", "POST /jsonapi/liabilities/{id}/relationships/ownership" ], "changed": [ "GET /jsonapi/adviser-details", "GET /jsonapi/adviser-details/{id}", "GET /jsonapi/adviser-details/{id}/adviser", "GET /jsonapi/adviser-details/{id}/relationships/adviser", "GET /jsonapi/advisers/{id}", "GET /jsonapi/assets/{id}/addresses", "GET /jsonapi/assets/{id}/ownership", "GET /jsonapi/assets/{id}/relationships/addresses", "GET /jsonapi/assets/{id}/relationships/ownership", "GET /jsonapi/deal-participants/{id}/contact", "GET /jsonapi/deal-participants/{id}/deal", "GET /jsonapi/deal-participants/{id}/relationships/contact", "GET /jsonapi/deal-participants/{id}/relationships/deal", "GET /jsonapi/deals/{id}/adviser", "GET /jsonapi/deals/{id}/contacts", "GET /jsonapi/deals/{id}/dealNotes", "GET /jsonapi/deals/{id}/dealScenario", "GET /jsonapi/deals/{id}/dealStructures", "GET /jsonapi/deals/{id}/externalReferences", "GET /jsonapi/deals/{id}/importantDates", "GET /jsonapi/deals/{id}/participants", "GET /jsonapi/deals/{id}/relationships/adviser", "GET /jsonapi/deals/{id}/relationships/contacts", "GET /jsonapi/deals/{id}/relationships/dealNotes", "GET /jsonapi/deals/{id}/relationships/dealScenario", "GET /jsonapi/deals/{id}/relationships/dealStructures", "GET /jsonapi/deals/{id}/relationships/externalReferences", "GET /jsonapi/deals/{id}/relationships/importantDates", "GET /jsonapi/deals/{id}/relationships/participants", "GET /jsonapi/expenses/{id}/ownership", "GET /jsonapi/expenses/{id}/relationships/ownership", "GET /jsonapi/incomes/{id}/linkedAsset", "GET /jsonapi/incomes/{id}/ownership", "GET /jsonapi/incomes/{id}/relationships/linkedAsset", "GET /jsonapi/incomes/{id}/relationships/ownership", "GET /jsonapi/liabilities/{id}/linkedAsset", "GET /jsonapi/liabilities/{id}/ownership", "GET /jsonapi/liabilities/{id}/relationships/linkedAsset", "GET /jsonapi/liabilities/{id}/relationships/ownership", "GET /jsonapi/organisations/{id}" ] }, "schemas": { "added": [], "removed": [ "ContactGroupReferrer", "ContactGroupReferrerAttributes", "ContactGroupReferrerDocument", "ContactGroupReferrerRelationships", "ContactGroupReferrersDocument", "ContactGroupReferrersEntityType" ], "changed": [ "FinancialRelationships", "IncludedResource" ] }, "changes": [ { "kind": "removed", "path": "/components/schemas/ContactGroupReferrer", "before": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupReferrersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupReferrerAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupReferrerRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/ContactGroupReferrerAttributes", "before": { "type": "object", "properties": { "referrerOrganisationName": { "type": "string", "nullable": true, "readOnly": true }, "referrerName": { "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "removed", "path": "/components/schemas/ContactGroupReferrerDocument", "before": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroupReferrer" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "removed", "path": "/components/schemas/ContactGroupReferrerRelationships", "before": { "type": "object" } }, { "kind": "removed", "path": "/components/schemas/ContactGroupReferrersDocument", "before": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroupReferrer" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "removed", "path": "/components/schemas/ContactGroupReferrersEntityType", "before": { "enum": [ "contact-group-referrers" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/FinancialRelationships/properties/incomes", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "removed", "path": "/components/schemas/IncludedResource/discriminator/mapping/contact-group-referrers", "before": "#/components/schemas/ContactGroupReferrer" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details/get/summary", "before": "Gets adviser details for a collection of advisers", "after": "Gets a collection of adviser details" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details/head", "after": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetails_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}/get/description", "before": "Where `id` is the identifier of the set of adviser details. aka ClientId, aka My Crm ID", "after": "Where `id` is the identifier of the adviser detail" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}/get/summary", "before": "Gets a single set of adviser details by id", "after": "Gets a single adviser detail by id" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}/head", "after": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetail_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/description", "before": "Where `id` is the identifier of the set of adviser details. aka ClientId, aka My Crm ID" }, { "kind": "removed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/summary", "before": "Gets advisers via the id of a single related set of adviser details" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/head", "after": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetailRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/get/description", "before": "Where `id` is the identifier of the set of adviser details. aka ClientId, aka My Crm ID" }, { "kind": "removed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/get/summary", "before": "Gets advisers related to a single set of adviser details" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/head", "after": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetailRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers/head", "after": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Advisers_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}/get/description", "before": "Where `id` is the identifier of the adviser. aka MyCrm family_id", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}/head", "after": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Adviser_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1addresses", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelated_Get_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelated_Get_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDetailsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1agreementHolders", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelated_Get_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AgreementHoldersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1contactGroups", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelated_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelated_Get_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1addresses", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelationship_Get_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1adviserDetails", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelationship_Get_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1agreementHolders", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelationship_Get_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1contactGroups", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelationship_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1organisation", "after": { "get": { "tags": [ "Adviser" ], "operationId": "AdviserRelationship_Get_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "AssetCategories" ], "operationId": "AssetCategoryRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategoryRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "AssetCategories" ], "operationId": "AssetCategoryRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategoryRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "AssetSubTypes" ], "operationId": "AssetSubTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "AssetSubTypes" ], "operationId": "AssetSubTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "AssetTypes" ], "operationId": "AssetTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "AssetTypes" ], "operationId": "AssetTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets/post", "before": { "tags": [ "Assets" ], "summary": "Creates a new asset with attributes, relationships or both", "operationId": "Asset_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}/delete", "before": { "tags": [ "Assets" ], "summary": "Deletes an existing asset", "description": "Where `id` is the identifier of the asset", "operationId": "Asset_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}/patch", "before": { "tags": [ "Assets" ], "summary": "Updates the attributes and/or relationships of an existing asset. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the asset", "operationId": "Asset_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1addresses/get/description", "before": "Where `id` is the identifier of the asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1addresses/get/summary", "before": "Gets addresses via a single related asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1ownership/get/description", "before": "Where `id` is the identifier of the asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1ownership/get/summary", "before": "Gets ownerships via a single related asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/delete", "before": { "tags": [ "Assets" ], "summary": "Removes a asset from a to-many relationship with addresses", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Delete_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/get/description", "before": "Where `id` is the identifier of the asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/get/summary", "before": "Gets a addresses related to a single asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/patch", "before": { "tags": [ "Assets" ], "summary": "Performs a complete replacement of a addresses relationship on an existing asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Patch_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/post", "before": { "tags": [ "Assets" ], "summary": "Adds addresses to a to-many relationship with an existing asset", "description": "Where `id` is the identifier of the primary asset resource", "operationId": "AssetRelationship_Post_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/delete", "before": { "tags": [ "Assets" ], "summary": "Removes a asset from a to-many relationship with ownerships", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Delete_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/get/description", "before": "Where `id` is the identifier of the asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/get/summary", "before": "Gets a ownerships related to a single asset" }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/patch", "before": { "tags": [ "Assets" ], "summary": "Performs a complete replacement of a ownership relationship on an existing asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Patch_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/post", "before": { "tags": [ "Assets" ], "summary": "Adds ownerships to a to-many relationship with an existing asset", "description": "Where `id` is the identifier of the primary asset resource", "operationId": "AssetRelationship_Post_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-group-referrers", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets a collection of referrers", "operationId": "ContactGroupReferrers_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupReferrers_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "Referrers" ], "summary": "Creates a new referrer with attributes, relationships or both", "operationId": "ContactGroupReferrer_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrerDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrerDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-group-referrers~1{id}", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets a single referrer by id", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrer_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrerDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupReferrer_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "Referrers" ], "summary": "Updates the attributes and/or relationships of an existing referrer. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrer_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrerDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupReferrerDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "Referrers" ], "summary": "Deletes an existing referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrer_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-group-referrers~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets a {{{RelationshipNames}}} related to a single referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrerRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupReferrerRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "Referrers" ], "summary": "Adds {{{RelationshipNames}}} to a to-many relationship with an existing referrer", "description": "Where `id` is the identifier of the primary referrer resource", "operationId": "ContactGroupReferrerRelationship_Post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": {} } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "Referrers" ], "summary": "Performs a complete replacement of a {{{RelationshipName}}} relationship on an existing referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrerRelationship_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": {} } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "Referrers" ], "summary": "Removes a referrer from a to-many relationship with {{{RelationshipNames}}}", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrerRelationship_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-group-referrers~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets {{{RelationshipNames}}} via a single related referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ContactGroupReferrerRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupReferrerRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants/post", "before": { "tags": [ "DealParticipants" ], "summary": "Creates a new participants in a deal with attributes, relationships or both", "operationId": "DealParticipant_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}/delete", "before": { "tags": [ "DealParticipants" ], "summary": "Deletes an existing participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipant_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}/patch", "before": { "tags": [ "DealParticipants" ], "summary": "Updates the attributes and/or relationships of an existing participants in a deal. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipant_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/description", "before": "Where `id` is the identifier of the participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/summary", "before": "Gets contacts via a single related participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/description", "before": "Where `id` is the identifier of the participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/summary", "before": "Gets deals via a single related participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/delete", "before": { "tags": [ "DealParticipants" ], "summary": "Removes a participants in a deal from a to-many relationship with contacts", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Delete_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/get/description", "before": "Where `id` is the identifier of the participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/get/summary", "before": "Gets a contacts related to a single participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/patch", "before": { "tags": [ "DealParticipants" ], "summary": "Performs a complete replacement of a contact relationship on an existing participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Patch_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/post", "before": { "tags": [ "DealParticipants" ], "summary": "Adds contacts to a to-many relationship with an existing participants in a deal", "description": "Where `id` is the identifier of the primary participants in a deal resource", "operationId": "DealParticipantRelationship_Post_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/delete", "before": { "tags": [ "DealParticipants" ], "summary": "Removes a participants in a deal from a to-many relationship with deals", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Delete_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/get/description", "before": "Where `id` is the identifier of the participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/get/summary", "before": "Gets a deals related to a single participants in a deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/patch", "before": { "tags": [ "DealParticipants" ], "summary": "Performs a complete replacement of a deal relationship on an existing participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Patch_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/post", "before": { "tags": [ "DealParticipants" ], "summary": "Adds deals to a to-many relationship with an existing participants in a deal", "description": "Where `id` is the identifier of the primary participants in a deal resource", "operationId": "DealParticipantRelationship_Post_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals/post", "before": { "tags": [ "Deals" ], "summary": "Creates a new deal with attributes, relationships or both", "operationId": "Deal_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}/delete", "before": { "tags": [ "Deals" ], "summary": "Deletes an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "Deal_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}/patch", "before": { "tags": [ "Deals" ], "summary": "Updates the attributes and/or relationships of an existing deal. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal", "operationId": "Deal_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/summary", "before": "Gets advisers via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1contacts/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1contacts/get/summary", "before": "Gets contacts via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealNotes/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealNotes/get/summary", "before": "Gets dealNotes via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/summary", "before": "Gets dealScenarios via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealStructures/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealStructures/get/summary", "before": "Gets dealStructures via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1externalReferences/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1externalReferences/get/summary", "before": "Gets externalReferences via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1importantDates/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1importantDates/get/summary", "before": "Gets importantDates via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1participants/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1participants/get/summary", "before": "Gets participants via a single related deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with advisers", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/get/summary", "before": "Gets a advisers related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a adviser relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/post", "before": { "tags": [ "Deals" ], "summary": "Adds advisers to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with contacts", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/get/summary", "before": "Gets a contacts related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a contacts relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/post", "before": { "tags": [ "Deals" ], "summary": "Adds contacts to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with dealNotes", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/get/summary", "before": "Gets a dealNotes related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a dealNotes relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/post", "before": { "tags": [ "Deals" ], "summary": "Adds dealNotes to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with dealScenarios", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/get/summary", "before": "Gets a dealScenarios related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a dealScenario relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/post", "before": { "tags": [ "Deals" ], "summary": "Adds dealScenarios to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with dealStructures", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/get/summary", "before": "Gets a dealStructures related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a dealStructures relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/post", "before": { "tags": [ "Deals" ], "summary": "Adds dealStructures to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with externalReferences", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/get/summary", "before": "Gets a externalReferences related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a externalReferences relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/post", "before": { "tags": [ "Deals" ], "summary": "Adds externalReferences to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with importantDates", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/get/summary", "before": "Gets a importantDates related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a importantDates relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/post", "before": { "tags": [ "Deals" ], "summary": "Adds importantDates to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/delete", "before": { "tags": [ "Deals" ], "summary": "Removes a deal from a to-many relationship with participants", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Delete_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/get/description", "before": "Where `id` is the identifier of the deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/get/summary", "before": "Gets a participants related to a single deal" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/patch", "before": { "tags": [ "Deals" ], "summary": "Performs a complete replacement of a participants relationship on an existing deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Patch_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/post", "before": { "tags": [ "Deals" ], "summary": "Adds participants to a to-many relationship with an existing deal", "description": "Where `id` is the identifier of the primary deal resource", "operationId": "DealRelationship_Post_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1expenseTypes", "after": { "get": { "tags": [ "ExpenseCategories" ], "operationId": "ExpenseCategoryRelated_Get_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategoryRelated_Head_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1relationships~1expenseTypes", "after": { "get": { "tags": [ "ExpenseCategories" ], "operationId": "ExpenseCategoryRelationship_Get_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategoryRelationship_Get_Head_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory", "after": { "get": { "tags": [ "ExpenseTypes" ], "operationId": "ExpenseTypeRelated_Get_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseTypeRelated_Head_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1relationships~1expenseCategory", "after": { "get": { "tags": [ "ExpenseTypes" ], "operationId": "ExpenseTypeRelationship_Get_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseTypeRelationship_Get_Head_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses/post", "before": { "tags": [ "Expenses" ], "summary": "Creates a new expense with attributes, relationships or both", "operationId": "Expense_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}/delete", "before": { "tags": [ "Expenses" ], "summary": "Deletes an existing expense", "description": "Where `id` is the identifier of the expense", "operationId": "Expense_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}/patch", "before": { "tags": [ "Expenses" ], "summary": "Updates the attributes and/or relationships of an existing expense. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the expense", "operationId": "Expense_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1ownership/get/description", "before": "Where `id` is the identifier of the expense" }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1ownership/get/summary", "before": "Gets ownerships via a single related expense" }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/delete", "before": { "tags": [ "Expenses" ], "summary": "Removes a expense from a to-many relationship with ownerships", "description": "Where `id` is the identifier of the expense", "operationId": "ExpenseRelationship_Delete_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/get/description", "before": "Where `id` is the identifier of the expense" }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/get/summary", "before": "Gets a ownerships related to a single expense" }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/patch", "before": { "tags": [ "Expenses" ], "summary": "Performs a complete replacement of a ownership relationship on an existing expense", "description": "Where `id` is the identifier of the expense", "operationId": "ExpenseRelationship_Patch_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/post", "before": { "tags": [ "Expenses" ], "summary": "Adds ownerships to a to-many relationship with an existing expense", "description": "Where `id` is the identifier of the primary expense resource", "operationId": "ExpenseRelationship_Post_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1incomeTypes", "after": { "get": { "tags": [ "IncomeCategories" ], "operationId": "IncomeCategoryRelated_Get_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategoryRelated_Head_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1relationships~1incomeTypes", "after": { "get": { "tags": [ "IncomeCategories" ], "operationId": "IncomeCategoryRelationship_Get_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategoryRelationship_Get_Head_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory", "after": { "get": { "tags": [ "IncomeTypes" ], "operationId": "IncomeTypeRelated_Get_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeTypeRelated_Head_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1relationships~1incomeCategory", "after": { "get": { "tags": [ "IncomeTypes" ], "operationId": "IncomeTypeRelationship_Get_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeTypeRelationship_Get_Head_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes/post", "before": { "tags": [ "Incomes" ], "summary": "Creates a new income with attributes, relationships or both", "operationId": "Income_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}/delete", "before": { "tags": [ "Incomes" ], "summary": "Deletes an existing income", "description": "Where `id` is the identifier of the income", "operationId": "Income_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}/patch", "before": { "tags": [ "Incomes" ], "summary": "Updates the attributes and/or relationships of an existing income. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the income", "operationId": "Income_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/description", "before": "Where `id` is the identifier of the income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/summary", "before": "Gets linkedAssets via a single related income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1ownership/get/description", "before": "Where `id` is the identifier of the income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1ownership/get/summary", "before": "Gets ownerships via a single related income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/delete", "before": { "tags": [ "Incomes" ], "summary": "Removes a income from a to-many relationship with linkedAssets", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Delete_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/get/description", "before": "Where `id` is the identifier of the income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/get/summary", "before": "Gets a linkedAssets related to a single income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/patch", "before": { "tags": [ "Incomes" ], "summary": "Performs a complete replacement of a linkedAsset relationship on an existing income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Patch_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/post", "before": { "tags": [ "Incomes" ], "summary": "Adds linkedAssets to a to-many relationship with an existing income", "description": "Where `id` is the identifier of the primary income resource", "operationId": "IncomeRelationship_Post_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/delete", "before": { "tags": [ "Incomes" ], "summary": "Removes a income from a to-many relationship with ownerships", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Delete_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/get/description", "before": "Where `id` is the identifier of the income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/get/summary", "before": "Gets a ownerships related to a single income" }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/patch", "before": { "tags": [ "Incomes" ], "summary": "Performs a complete replacement of a ownership relationship on an existing income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Patch_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/post", "before": { "tags": [ "Incomes" ], "summary": "Adds ownerships to a to-many relationship with an existing income", "description": "Where `id` is the identifier of the primary income resource", "operationId": "IncomeRelationship_Post_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities/post", "before": { "tags": [ "Liabilities" ], "summary": "Creates a new liabilities with attributes, relationships or both", "operationId": "Liability_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}/delete", "before": { "tags": [ "Liabilities" ], "summary": "Deletes an existing liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "Liability_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}/patch", "before": { "tags": [ "Liabilities" ], "summary": "Updates the attributes and/or relationships of an existing liabilities. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the liabilities", "operationId": "Liability_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/description", "before": "Where `id` is the identifier of the liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/summary", "before": "Gets linkedAssets via a single related liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1ownership/get/description", "before": "Where `id` is the identifier of the liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1ownership/get/summary", "before": "Gets ownerships via a single related liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/delete", "before": { "tags": [ "Liabilities" ], "summary": "Removes a liabilities from a to-many relationship with linkedAssets", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Delete_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/get/description", "before": "Where `id` is the identifier of the liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/get/summary", "before": "Gets a linkedAssets related to a single liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/patch", "before": { "tags": [ "Liabilities" ], "summary": "Performs a complete replacement of a linkedAsset relationship on an existing liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Patch_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/post", "before": { "tags": [ "Liabilities" ], "summary": "Adds linkedAssets to a to-many relationship with an existing liabilities", "description": "Where `id` is the identifier of the primary liabilities resource", "operationId": "LiabilityRelationship_Post_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/delete", "before": { "tags": [ "Liabilities" ], "summary": "Removes a liabilities from a to-many relationship with ownerships", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Delete_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/get/description", "before": "Where `id` is the identifier of the liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/get/summary", "before": "Gets a ownerships related to a single liabilities" }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/patch", "before": { "tags": [ "Liabilities" ], "summary": "Performs a complete replacement of a ownership relationship on an existing liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Patch_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/post", "before": { "tags": [ "Liabilities" ], "summary": "Adds ownerships to a to-many relationship with an existing liabilities", "description": "Where `id` is the identifier of the primary liabilities resource", "operationId": "LiabilityRelationship_Post_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1liabilityTypes", "after": { "get": { "tags": [ "LiabilityCategories" ], "operationId": "LiabilityCategoryRelated_Get_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategoryRelated_Head_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1relationships~1liabilityTypes", "after": { "get": { "tags": [ "LiabilityCategories" ], "operationId": "LiabilityCategoryRelationship_Get_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategoryRelationship_Get_Head_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory", "after": { "get": { "tags": [ "LiabilityTypes" ], "operationId": "LiabilityTypeRelated_Get_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelated_Head_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilityCategory", "after": { "get": { "tags": [ "LiabilityTypes" ], "operationId": "LiabilityTypeRelationship_Get_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelationship_Get_Head_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations/head", "after": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Organisations_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1organisations~1{id}/get/description", "before": "Where `id` is the identifier of the organisation. aka OrgId", "after": "Where `id` is the identifier of the organisation" }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}/head", "after": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Organisation_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1addresses", "after": { "get": { "tags": [ "Organisations" ], "operationId": "OrganisationRelated_Get_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelated_Head_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1relationships~1addresses", "after": { "get": { "tags": [ "Organisations" ], "operationId": "OrganisationRelationship_Get_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelationship_Get_Head_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers", "after": { "get": { "tags": [ "Referrers" ], "summary": "Gets a collection of referrers", "operationId": "Referrers_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Referrers_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}", "after": { "get": { "tags": [ "Referrers" ], "summary": "Gets a single referrer by id", "description": "Where `id` is the identifier of the referrer", "operationId": "Referrer_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrerDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Referrer_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "Referrers" ], "operationId": "ReferrerRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ReferrerRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "Referrers" ], "operationId": "ReferrerRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ReferrerRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "c3eff952d55082dad6844325dc4df78a24345b21", "committedAt": "2022-02-15T17:41:28+10:00", "date": "2022-02-15", "title": "Clearer relationship descriptions", "highlights": [ "Adds descriptions explaining which parent record identifies each related-resource and relationship request.", "This is a reference clarification; operation availability and schemas are unchanged." ], "swaggerSha256": "27fa9dccc3846099bffbd37c6443e2ca094e099445a344e814346fa63f728bbd", "counts": { "operations": 379, "paths": 157, "schemas": 291 }, "operations": { "added": [], "removed": [], "changed": [ "GET /jsonapi/adviser-details/{id}/adviser", "GET /jsonapi/adviser-details/{id}/relationships/adviser", "GET /jsonapi/advisers/{id}/addresses", "GET /jsonapi/advisers/{id}/adviserDetails", "GET /jsonapi/advisers/{id}/agreementHolders", "GET /jsonapi/advisers/{id}/contactGroups", "GET /jsonapi/advisers/{id}/organisation", "GET /jsonapi/advisers/{id}/relationships/addresses", "GET /jsonapi/advisers/{id}/relationships/adviserDetails", "GET /jsonapi/advisers/{id}/relationships/agreementHolders", "GET /jsonapi/advisers/{id}/relationships/contactGroups", "GET /jsonapi/advisers/{id}/relationships/organisation", "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/assets/{id}/addresses", "GET /jsonapi/assets/{id}/ownership", "GET /jsonapi/assets/{id}/relationships/addresses", "GET /jsonapi/assets/{id}/relationships/ownership", "GET /jsonapi/deal-participants/{id}/contact", "GET /jsonapi/deal-participants/{id}/deal", "GET /jsonapi/deal-participants/{id}/relationships/contact", "GET /jsonapi/deal-participants/{id}/relationships/deal", "GET /jsonapi/deals/{id}/adviser", "GET /jsonapi/deals/{id}/contacts", "GET /jsonapi/deals/{id}/dealNotes", "GET /jsonapi/deals/{id}/dealScenario", "GET /jsonapi/deals/{id}/dealStructures", "GET /jsonapi/deals/{id}/externalReferences", "GET /jsonapi/deals/{id}/importantDates", "GET /jsonapi/deals/{id}/participants", "GET /jsonapi/deals/{id}/relationships/adviser", "GET /jsonapi/deals/{id}/relationships/contacts", "GET /jsonapi/deals/{id}/relationships/dealNotes", "GET /jsonapi/deals/{id}/relationships/dealScenario", "GET /jsonapi/deals/{id}/relationships/dealStructures", "GET /jsonapi/deals/{id}/relationships/externalReferences", "GET /jsonapi/deals/{id}/relationships/importantDates", "GET /jsonapi/deals/{id}/relationships/participants", "GET /jsonapi/expense-categories/{id}/expenseTypes", "GET /jsonapi/expense-categories/{id}/relationships/expenseTypes", "GET /jsonapi/expense-types/{id}/expenseCategory", "GET /jsonapi/expense-types/{id}/relationships/expenseCategory", "GET /jsonapi/expenses/{id}/ownership", "GET /jsonapi/expenses/{id}/relationships/ownership", "GET /jsonapi/income-categories/{id}/incomeTypes", "GET /jsonapi/income-categories/{id}/relationships/incomeTypes", "GET /jsonapi/income-types/{id}/incomeCategory", "GET /jsonapi/income-types/{id}/relationships/incomeCategory", "GET /jsonapi/incomes/{id}/linkedAsset", "GET /jsonapi/incomes/{id}/ownership", "GET /jsonapi/incomes/{id}/relationships/linkedAsset", "GET /jsonapi/incomes/{id}/relationships/ownership", "GET /jsonapi/liabilities/{id}/linkedAsset", "GET /jsonapi/liabilities/{id}/ownership", "GET /jsonapi/liabilities/{id}/relationships/linkedAsset", "GET /jsonapi/liabilities/{id}/relationships/ownership", "GET /jsonapi/liability-categories/{id}/liabilityTypes", "GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes", "GET /jsonapi/liability-types/{id}/liabilityCategory", "GET /jsonapi/liability-types/{id}/relationships/liabilityCategory", "GET /jsonapi/organisations/{id}/addresses", "GET /jsonapi/organisations/{id}/relationships/addresses", "GET /jsonapi/referrers/{id}/relationships/{relationshipName}", "GET /jsonapi/referrers/{id}/{relationshipName}" ] }, "schemas": { "added": [], "removed": [], "changed": [] }, "changes": [ { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/description", "after": "Where `id` is the identifier of the adviser detail" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/summary", "after": "Gets advisers via a single related adviser detail" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/get/description", "after": "Where `id` is the identifier of the adviser detail" }, { "kind": "added", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/get/summary", "after": "Gets a advisers related to a single adviser detail" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1addresses/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1addresses/get/summary", "after": "Gets addresses via a single related adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails/get/summary", "after": "Gets adviserDetails via a single related adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1agreementHolders/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1agreementHolders/get/summary", "after": "Gets agreementHolders via a single related adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1contactGroups/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1contactGroups/get/summary", "after": "Gets contactGroups via a single related adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation/get/summary", "after": "Gets organisations via a single related adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1addresses/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1addresses/get/summary", "after": "Gets a addresses related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1adviserDetails/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1adviserDetails/get/summary", "after": "Gets a adviserDetails related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1agreementHolders/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1agreementHolders/get/summary", "after": "Gets a agreementHolders related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1contactGroups/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1contactGroups/get/summary", "after": "Gets a contactGroups related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1organisation/get/description", "after": "Where `id` is the identifier of the adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1organisation/get/summary", "after": "Gets a organisations related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1relationships~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset category" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1relationships~1{relationshipName}/get/summary", "after": "Gets a {{{RelationshipNames}}} related to a single asset category" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset category" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1{relationshipName}/get/summary", "after": "Gets {{{RelationshipNames}}} via a single related asset category" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1relationships~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset sub-type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1relationships~1{relationshipName}/get/summary", "after": "Gets a {{{RelationshipNames}}} related to a single asset sub-type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset sub-type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1{relationshipName}/get/summary", "after": "Gets {{{RelationshipNames}}} via a single related asset sub-type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1relationships~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1relationships~1{relationshipName}/get/summary", "after": "Gets a {{{RelationshipNames}}} related to a single asset type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the asset type" }, { "kind": "added", "path": "/paths/~1jsonapi~1asset-types~1{id}~1{relationshipName}/get/summary", "after": "Gets {{{RelationshipNames}}} via a single related asset type" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1addresses/get/description", "after": "Where `id` is the identifier of the asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1addresses/get/summary", "after": "Gets addresses via a single related asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1ownership/get/description", "after": "Where `id` is the identifier of the asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1ownership/get/summary", "after": "Gets ownerships via a single related asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/get/description", "after": "Where `id` is the identifier of the asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/get/summary", "after": "Gets a addresses related to a single asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/get/description", "after": "Where `id` is the identifier of the asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/get/summary", "after": "Gets a ownerships related to a single asset" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/description", "after": "Where `id` is the identifier of the participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/summary", "after": "Gets contacts via a single related participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/description", "after": "Where `id` is the identifier of the participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/summary", "after": "Gets deals via a single related participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/get/description", "after": "Where `id` is the identifier of the participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/get/summary", "after": "Gets a contacts related to a single participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/get/description", "after": "Where `id` is the identifier of the participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/get/summary", "after": "Gets a deals related to a single participants in a deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/summary", "after": "Gets advisers via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1contacts/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1contacts/get/summary", "after": "Gets contacts via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealNotes/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealNotes/get/summary", "after": "Gets dealNotes via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/summary", "after": "Gets dealScenarios via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealStructures/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1dealStructures/get/summary", "after": "Gets dealStructures via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1externalReferences/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1externalReferences/get/summary", "after": "Gets externalReferences via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1importantDates/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1importantDates/get/summary", "after": "Gets importantDates via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1participants/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1participants/get/summary", "after": "Gets participants via a single related deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/get/summary", "after": "Gets a advisers related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/get/summary", "after": "Gets a contacts related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/get/summary", "after": "Gets a dealNotes related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/get/summary", "after": "Gets a dealScenarios related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/get/summary", "after": "Gets a dealStructures related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/get/summary", "after": "Gets a externalReferences related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/get/summary", "after": "Gets a importantDates related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/get/description", "after": "Where `id` is the identifier of the deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/get/summary", "after": "Gets a participants related to a single deal" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1expenseTypes/get/description", "after": "Where `id` is the identifier of the expense category" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1expenseTypes/get/summary", "after": "Gets expenseTypes via a single related expense category" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1relationships~1expenseTypes/get/description", "after": "Where `id` is the identifier of the expense category" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1relationships~1expenseTypes/get/summary", "after": "Gets a expenseTypes related to a single expense category" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory/get/description", "after": "Where `id` is the identifier of the expense type" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory/get/summary", "after": "Gets expenseCategories via a single related expense type" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1relationships~1expenseCategory/get/description", "after": "Where `id` is the identifier of the expense type" }, { "kind": "added", "path": "/paths/~1jsonapi~1expense-types~1{id}~1relationships~1expenseCategory/get/summary", "after": "Gets a expenseCategories related to a single expense type" }, { "kind": "added", "path": "/paths/~1jsonapi~1expenses~1{id}~1ownership/get/description", "after": "Where `id` is the identifier of the expense" }, { "kind": "added", "path": "/paths/~1jsonapi~1expenses~1{id}~1ownership/get/summary", "after": "Gets ownerships via a single related expense" }, { "kind": "added", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/get/description", "after": "Where `id` is the identifier of the expense" }, { "kind": "added", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/get/summary", "after": "Gets a ownerships related to a single expense" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1incomeTypes/get/description", "after": "Where `id` is the identifier of the income category" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1incomeTypes/get/summary", "after": "Gets incomeTypes via a single related income category" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1relationships~1incomeTypes/get/description", "after": "Where `id` is the identifier of the income category" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-categories~1{id}~1relationships~1incomeTypes/get/summary", "after": "Gets a incomeTypes related to a single income category" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory/get/description", "after": "Where `id` is the identifier of the income type" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory/get/summary", "after": "Gets incomeCategories via a single related income type" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1relationships~1incomeCategory/get/description", "after": "Where `id` is the identifier of the income type" }, { "kind": "added", "path": "/paths/~1jsonapi~1income-types~1{id}~1relationships~1incomeCategory/get/summary", "after": "Gets a incomeCategories related to a single income type" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/description", "after": "Where `id` is the identifier of the income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/summary", "after": "Gets linkedAssets via a single related income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1ownership/get/description", "after": "Where `id` is the identifier of the income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1ownership/get/summary", "after": "Gets ownerships via a single related income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/get/description", "after": "Where `id` is the identifier of the income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/get/summary", "after": "Gets a linkedAssets related to a single income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/get/description", "after": "Where `id` is the identifier of the income" }, { "kind": "added", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/get/summary", "after": "Gets a ownerships related to a single income" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/description", "after": "Where `id` is the identifier of the liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/summary", "after": "Gets linkedAssets via a single related liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1ownership/get/description", "after": "Where `id` is the identifier of the liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1ownership/get/summary", "after": "Gets ownerships via a single related liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/get/description", "after": "Where `id` is the identifier of the liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/get/summary", "after": "Gets a linkedAssets related to a single liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/get/description", "after": "Where `id` is the identifier of the liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/get/summary", "after": "Gets a ownerships related to a single liabilities" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1liabilityTypes/get/description", "after": "Where `id` is the identifier of the liability category" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1liabilityTypes/get/summary", "after": "Gets liabilityTypes via a single related liability category" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1relationships~1liabilityTypes/get/description", "after": "Where `id` is the identifier of the liability category" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1relationships~1liabilityTypes/get/summary", "after": "Gets a liabilityTypes related to a single liability category" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory/get/description", "after": "Where `id` is the identifier of the liability type" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory/get/summary", "after": "Gets liabilityCategories via a single related liability type" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilityCategory/get/description", "after": "Where `id` is the identifier of the liability type" }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilityCategory/get/summary", "after": "Gets a liabilityCategories related to a single liability type" }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1addresses/get/description", "after": "Where `id` is the identifier of the organisation" }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1addresses/get/summary", "after": "Gets addresses via a single related organisation" }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1relationships~1addresses/get/description", "after": "Where `id` is the identifier of the organisation" }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1relationships~1addresses/get/summary", "after": "Gets a addresses related to a single organisation" }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1relationships~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the referrer" }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1relationships~1{relationshipName}/get/summary", "after": "Gets a {{{RelationshipNames}}} related to a single referrer" }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1{relationshipName}/get/description", "after": "Where `id` is the identifier of the referrer" }, { "kind": "added", "path": "/paths/~1jsonapi~1referrers~1{id}~1{relationshipName}/get/summary", "after": "Gets {{{RelationshipNames}}} via a single related referrer" } ] }, { "commit": "c2af492fc09f4375be78a16a4dadace948830cfe", "committedAt": "2022-02-16T15:18:43+10:00", "date": "2022-02-16", "title": "Financial relationship cleanup", "highlights": [ "Removes the `financial` relationship from asset, expense, income, liability and owner response models." ], "compatibility": "Clients should not rely on the removed relationship being present in these resources.", "swaggerSha256": "c804586e262e46a062b6ac6c019e62aac97e0a17f8fb723ee96454427d75be34", "counts": { "operations": 379, "paths": 157, "schemas": 291 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "AssetRelationships", "ExpenseRelationships", "IncomeRelationships", "LiabilityRelationships", "OwnerRelationships" ] }, "changes": [ { "kind": "removed", "path": "/components/schemas/AssetRelationships/properties/financial", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "removed", "path": "/components/schemas/ExpenseRelationships/properties/financial", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "removed", "path": "/components/schemas/IncomeRelationships/properties/financial", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "removed", "path": "/components/schemas/LiabilityRelationships/properties/financial", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "removed", "path": "/components/schemas/OwnerRelationships/properties/financial", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } ] }, { "commit": "9052694439f7818e73bfac400de24557761bb3f5", "committedAt": "2022-04-05T08:56:41+10:00", "date": "2022-04-05", "title": "Richer adviser, contact and opportunity details", "highlights": [ "Adviser details gain country and website information; adviser-detail and contact schemas gain gender fields.", "Contacts gain primary-contact and role fields. High-level summaries and opportunities gain `loanPurpose`." ], "swaggerSha256": "dcf424d1cd2a99a3814de504d6123162551bccb787ef86d4498f8ec7f26c46a2", "counts": { "operations": 379, "paths": 157, "schemas": 294 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [ "ContactRole", "CountryCode", "GenderCode" ], "removed": [], "changed": [ "AdviserAttributes", "AdviserDetailAttributes", "ContactAttributes", "HighLevelSummaryAttributes", "Opportunity" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AdviserAttributes/properties/countryCode", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ], "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AdviserAttributes/properties/website", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/AdviserDetailAttributes/properties/gender", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/GenderCode" } ] } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/gender", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/GenderCode" } ] } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/isPrimary", "after": { "type": "boolean", "nullable": true } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/role", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ContactRole" } ], "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactRole", "after": { "enum": [ "Adult", "Child", "Other" ], "type": "string", "x-ms-enum": { "name": "ContactRole", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/CountryCode", "after": { "enum": [ "NZ", "AU", "ID" ], "type": "string", "x-ms-enum": { "name": "CountryCode", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/GenderCode", "after": { "enum": [ "Male", "Female", "Undisclosed" ], "type": "string", "x-ms-enum": { "name": "GenderCode", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/HighLevelSummaryAttributes/properties/loanPurpose", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Opportunity/properties/loanPurpose", "after": { "type": "string", "nullable": true } } ] }, { "commit": "8defde51f977baab0be111a169a3e8256fffa917", "committedAt": "2022-04-07T14:58:58+10:00", "date": "2022-04-07", "title": "More complete structured leads", "highlights": [ "Adds GET and HEAD access to property types and their generic relationship routes.", "Structured leads gain employment, income and liability collections. Contacts gain additional phone and email fields, while lead contacts gain employment details.", "Lead assets gain address, property purpose, type, zoning and value-basis fields. Lead address and contact fields receive explicit length limits." ], "compatibility": "Lead asset and expense ownership shapes change, and several earlier asset flags and the property-type enum are removed. Review structured lead payloads against this release’s OpenAPI Specification.", "swaggerSha256": "a3a5eb43a57dafdaf46ba12e1dcb35c02bff1039d59901b9f44de41f5e15b44e", "counts": { "operations": 387, "paths": 161, "schemas": 311 }, "operations": { "added": [ "GET /jsonapi/property-types", "GET /jsonapi/property-types/{id}", "GET /jsonapi/property-types/{id}/relationships/{relationshipName}", "GET /jsonapi/property-types/{id}/{relationshipName}", "HEAD /jsonapi/property-types", "HEAD /jsonapi/property-types/{id}", "HEAD /jsonapi/property-types/{id}/relationships/{relationshipName}", "HEAD /jsonapi/property-types/{id}/{relationshipName}" ], "removed": [], "changed": [] }, "schemas": { "added": [ "ApiClientEntityEmployment", "EmployerType", "EmploymentBasis", "EmploymentStatus", "EmploymentType", "IncomeVerificationEnum", "LeadEmployment", "LeadIncome", "LeadLiability", "MortgagePriority", "PropertyPrimaryPurpose", "PropertyType", "PropertyTypeAttributes", "PropertyTypeDocument", "PropertyTypeRelationships", "PropertyTypesDocument", "PropertyTypesEntityType", "PropertyValueEstimatedBasis", "PropertyZoningTypesEntityType" ], "removed": [ "AddressPropertyType", "LeadOwnership" ], "changed": [ "BusinessRelationships", "ContactAttributes", "ContactRelationships", "IncludedResource", "LeadAddress", "LeadAsset", "LeadContact", "LeadExpense", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "removed", "path": "/components/schemas/AddressPropertyType", "before": { "enum": [ "AptUnitFlat", "BedsitterBachelor", "BoardingHouse", "CombiShopResidence", "Commercial", "CompanyTitleUnit", "ConvertedCommercialProperty", "ConvertedIndustrialProperty", "ConvertedMotelUnits", "ConvertedProperty", "DisplayHome", "Duplex", "FullyDetachedHouse", "GovtRentalGuarantee", "HobbyFarm", "HolidayHome", "HolidayRental", "Industrial", "InnerCityApartment", "KitHome", "LicencedBuilderHouseConstruction", "LuxuryHouse", "LuxuryOther", "MultipleOnTitle", "NewStrataTitleUnit", "NursingHome", "OwnerBuilderHouseConstruction", "PropertyDevelopment", "RelocatableHome", "RentalGuarantee", "ResortUnit", "RetirementUnit", "SemiDetachedHouse", "ServicedApt", "SingleBedroomLess50m2", "Snowlease", "StrataTitleUnit", "StudentAccommodation", "StudioWarehouseApt", "Terrace", "Timeshare", "Townhouse", "TransportableHome", "UnitStudentAccom", "VacantLand2", "Villa", "WarehouseConversion", "ProfChambers", "Offices", "Factory", "Warehouse", "VacantLand", "RetirementVillage", "NonSpecialisedCommercial", "ResidentialCommercial", "Other", "Item8HectaresOrLess", "Over8LessThan40Hectares", "Over40Hectares", "NonSpecialisedIndustrial", "LightIndustrial", "Other2", "AttachedUnit", "Guarantee", "LandOnly", "Lifestyle", "ResidentialLeasehold", "StdResidential", "MaoriLand", "CrossLease" ], "type": "string", "x-ms-enum": { "name": "AddressPropertyType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/ApiClientEntityEmployment", "after": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "business": { "$ref": "#/components/schemas/Business" }, "address": { "$ref": "#/components/schemas/Address" }, "contact": { "$ref": "#/components/schemas/Contact" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/BusinessRelationships/properties/employments", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/businessPhone", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/homePhone", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/secondaryEmail", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/employments", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/EmployerType", "after": { "enum": [ "Private", "Public" ], "type": "string", "x-ms-enum": { "name": "EmployerType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/EmploymentBasis", "after": { "enum": [ "FullTime", "PartTime", "Contract", "Temporary", "Casual" ], "type": "string", "x-ms-enum": { "name": "EmploymentBasis", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/EmploymentStatus", "after": { "enum": [ "PrimaryEmployment", "SecondaryEmployment", "PreviousEmployment" ], "type": "string", "x-ms-enum": { "name": "EmploymentStatus", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/EmploymentType", "after": { "enum": [ "PAYG", "SelfEmployed", "Unemployed", "Retired", "HomeDuties", "Student" ], "type": "string", "x-ms-enum": { "name": "EmploymentType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/property-types", "after": "#/components/schemas/PropertyType" }, { "kind": "added", "path": "/components/schemas/IncomeVerificationEnum", "after": { "enum": [ "CurrentPayslips", "CurrentGroupCertificate", "CurrentPersonalTaxReturn", "PreviousYearPersonalTaxReturn", "NoticeOfAssessment", "CurrentCompanyTaxReturn", "PreviousCompanyTaxReturn", "LetterFromEmployer", "EmploymentContract", "BankAccountStatement", "Other" ], "type": "string", "x-ms-enum": { "name": "IncomeVerificationEnum", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/country/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/country/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/formattedAddress/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/formattedAddress/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/postCode/maxLength", "after": 4 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/postCode/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/state/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/state/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/streetAddress/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/streetAddress/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/suburb/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAddress/properties/suburb/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/address", "after": { "$ref": "#/components/schemas/LeadAddress" } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/description/maxLength", "after": 500 }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/description/minLength", "after": 0 }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/isAccountDetailsKnown", "before": { "type": "boolean", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/isExistingMortgages", "before": { "type": "boolean", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/isRentalIncome", "before": { "type": "boolean", "nullable": true } }, { "kind": "changed", "path": "/components/schemas/LeadAsset/properties/ownership/items/$ref", "before": "#/components/schemas/LeadOwnership", "after": "#/components/schemas/LeadContact" }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/propertyPrimaryPurpose", "after": { "$ref": "#/components/schemas/PropertyPrimaryPurpose" } }, { "kind": "removed", "path": "/components/schemas/LeadAsset/properties/propertyType", "before": { "$ref": "#/components/schemas/AddressPropertyType" } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/propertyTypeId", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/propertyZoningId", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadAsset/properties/valueBasis", "after": { "$ref": "#/components/schemas/PropertyValueEstimatedBasis" } }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/businessPhone", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/email/maxLength", "after": 100 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/email/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/employments", "after": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmployment" }, "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/firstName/maxLength", "after": 100 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/firstName/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/homePhone", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/lastName/maxLength", "after": 100 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/lastName/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/mobile/maxLength", "after": 100 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/mobile/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/preferredName/maxLength", "after": 100 }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/preferredName/minLength", "after": 0 }, { "kind": "added", "path": "/components/schemas/LeadEmployment", "after": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "employmentStatus": { "$ref": "#/components/schemas/EmploymentStatus" }, "employmentType": { "$ref": "#/components/schemas/EmploymentType" }, "dateStartedAsString": { "type": "string", "format": "date", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "dateEndedAsString": { "type": "string", "format": "date", "nullable": true }, "dateEnded": { "type": "string", "format": "date-time", "nullable": true }, "employmentRoleName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "employmentBasis": { "$ref": "#/components/schemas/EmploymentBasis" }, "isProbation": { "type": "boolean", "nullable": true }, "businessNumber": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "companyNumber": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "employerName": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "employerContactTitle": { "$ref": "#/components/schemas/Title" }, "employerContactFirstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employerContactLastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employerType": { "$ref": "#/components/schemas/EmployerType" }, "employerPhone": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/LeadAddress" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/LeadExpense/properties/ownership/items/$ref", "before": "#/components/schemas/LeadOwnership", "after": "#/components/schemas/LeadContact" }, { "kind": "added", "path": "/components/schemas/LeadIncome", "after": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "incomeTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "frequency": { "$ref": "#/components/schemas/Frequency" }, "incomeVerification": { "$ref": "#/components/schemas/IncomeVerificationEnum" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContact" }, "nullable": true }, "asset": { "$ref": "#/components/schemas/LeadAsset" }, "employment": { "$ref": "#/components/schemas/LeadEmployment" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LeadLiability", "after": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "liabilityTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "bsb": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accountNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "limit": { "type": "number", "format": "double", "nullable": true }, "repayments": { "type": "number", "format": "double", "nullable": true }, "repaymentFrequency": { "$ref": "#/components/schemas/Frequency" }, "interestRate": { "type": "number", "format": "double", "nullable": true }, "interestTaxDeductible": { "type": "boolean", "nullable": true }, "creditorName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "loanTerm": { "type": "integer", "format": "int32", "nullable": true }, "loanRepaymentType": { "$ref": "#/components/schemas/LiabilityRepaymentType" }, "mortgagePriority": { "$ref": "#/components/schemas/MortgagePriority" }, "asset": { "$ref": "#/components/schemas/LeadAsset" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContact" }, "nullable": true } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/LeadOwnership", "before": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "contact": { "$ref": "#/components/schemas/LeadContact" }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/MortgagePriority", "after": { "enum": [ "First", "Second", "Third" ], "type": "string", "x-ms-enum": { "name": "MortgagePriority", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/PropertyPrimaryPurpose", "after": { "enum": [ "PurchaseOwnerOccupied", "PurchaseInvestment" ], "type": "string", "x-ms-enum": { "name": "PropertyPrimaryPurpose", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/PropertyType", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/PropertyTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/PropertyTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/PropertyTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/PropertyTypeAttributes", "after": { "type": "object", "properties": { "propertyZoningType": { "type": "string", "nullable": true, "readOnly": true }, "name": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "propertyZoningTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/PropertyTypeDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/PropertyType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/PropertyTypeRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/PropertyTypesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/PropertyTypesEntityType", "after": { "enum": [ "property-types" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/PropertyValueEstimatedBasis", "after": { "enum": [ "ApplicantEstimate", "CertifiedValuation", "ActualValue" ], "type": "string", "x-ms-enum": { "name": "PropertyValueEstimatedBasis", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/PropertyZoningTypesEntityType", "after": { "enum": [ "property-zoning-types" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/employments", "after": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmployment" }, "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/incomes", "after": { "type": "array", "items": { "$ref": "#/components/schemas/LeadIncome" }, "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/liabilities", "after": { "type": "array", "items": { "$ref": "#/components/schemas/LeadLiability" }, "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/paths/~1jsonapi~1property-types", "after": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a collection of property types", "operationId": "PropertyTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PropertyTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypes_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1property-types~1{id}", "after": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a single property type by id", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PropertyTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1property-types~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a {{{RelationshipNames}}} related to a single property type", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1property-types~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets {{{RelationshipNames}}} via a single related property type", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "45970304f98cb059b1e160eaacaf4b9ba135dd43", "committedAt": "2022-04-13T13:54:08+10:00", "date": "2022-04-13", "title": "References within structured lead payloads", "highlights": [ "Introduces dedicated address, asset, contact and employment reference models for nested structured lead data.", "Updates links between lead assets, contacts, employments, incomes and liabilities to use those reference models." ], "compatibility": "Review nested objects and ownership references when generating or serialising structured lead requests.", "swaggerSha256": "6bc9a7b24d6fd231382f309ba94a743268fe89751f0b35685c5f24e3d60c22cb", "counts": { "operations": 387, "paths": 161, "schemas": 315 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [ "LeadAddressReference", "LeadAssetReference", "LeadContactReference", "LeadEmploymentReference" ], "removed": [], "changed": [ "DealNoteAttributes", "LeadAsset", "LeadContact", "LeadEmployment", "LeadExpense", "LeadIncome", "LeadLiability" ] }, "changes": [ { "kind": "changed", "path": "/components/schemas/DealNoteAttributes/properties/title/maxLength", "before": 200, "after": 2000 }, { "kind": "added", "path": "/components/schemas/LeadAddressReference", "after": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "type": "string" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/LeadAsset/properties/address/$ref", "before": "#/components/schemas/LeadAddress", "after": "#/components/schemas/LeadAddressReference" }, { "kind": "changed", "path": "/components/schemas/LeadAsset/properties/ownership/items/$ref", "before": "#/components/schemas/LeadContact", "after": "#/components/schemas/LeadContactReference" }, { "kind": "added", "path": "/components/schemas/LeadAssetReference", "after": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "type": "string" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/LeadContact/properties/addresses/items/$ref", "before": "#/components/schemas/LeadAddress", "after": "#/components/schemas/LeadAddressReference" }, { "kind": "changed", "path": "/components/schemas/LeadContact/properties/employments/items/$ref", "before": "#/components/schemas/LeadEmployment", "after": "#/components/schemas/LeadEmploymentReference" }, { "kind": "added", "path": "/components/schemas/LeadContactReference", "after": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "type": "string" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/LeadEmployment/properties/address/$ref", "before": "#/components/schemas/LeadAddress", "after": "#/components/schemas/LeadAddressReference" }, { "kind": "added", "path": "/components/schemas/LeadEmploymentReference", "after": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "type": "string" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/LeadExpense/properties/ownership/items/$ref", "before": "#/components/schemas/LeadContact", "after": "#/components/schemas/LeadContactReference" }, { "kind": "changed", "path": "/components/schemas/LeadIncome/properties/asset/$ref", "before": "#/components/schemas/LeadAsset", "after": "#/components/schemas/LeadAssetReference" }, { "kind": "changed", "path": "/components/schemas/LeadIncome/properties/employment/$ref", "before": "#/components/schemas/LeadEmployment", "after": "#/components/schemas/LeadEmploymentReference" }, { "kind": "changed", "path": "/components/schemas/LeadIncome/properties/ownership/items/$ref", "before": "#/components/schemas/LeadContact", "after": "#/components/schemas/LeadContactReference" }, { "kind": "changed", "path": "/components/schemas/LeadLiability/properties/asset/$ref", "before": "#/components/schemas/LeadAsset", "after": "#/components/schemas/LeadAssetReference" }, { "kind": "changed", "path": "/components/schemas/LeadLiability/properties/ownership/items/$ref", "before": "#/components/schemas/LeadContact", "after": "#/components/schemas/LeadContactReference" } ] }, { "commit": "d01983ec678995e39b2f0d3d8ebbe77c0234bb49", "committedAt": "2022-05-03T08:16:46+10:00", "date": "2022-05-03", "title": "JSON:API error and document schemas", "highlights": [ "Refreshes shared JSON:API document and resource schemas, replacing the earlier error models with `ErrorObject`.", "Error links gain a `type` link, error sources gain `header`, and the top-level described-by link is named `describedby`." ], "compatibility": "Regenerate typed clients that use the former error models or the `describedBy` spelling.", "swaggerSha256": "887973f9d160ff1d27e88c57202523bf0368b0becef4534a8672dc21e0061f84", "counts": { "operations": 387, "paths": 161, "schemas": 322 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [ "ApiFamilyFranchisee", "ErrorObject", "RelationshipObject", "ResourceObject", "ResourceObjectAttributes", "ResourceObjectDocument", "ResourceObjectRelationships", "ResourceObjectsDocument", "SingleOrManyData`1" ], "removed": [ "Error", "ErrorMeta" ], "changed": [ "AdviserRelationships", "AgreementHolderRelationships", "ContactAddressRelationships", "ContactRelationships", "ErrorDocument", "ErrorLinks", "ErrorSource", "TopLevelLinks" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AdviserRelationships/properties/familyFranchisees", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/AgreementHolderRelationships/properties/apiFamilyFranchisees", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/ApiFamilyFranchisee", "after": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "franchiseeDetails": { "$ref": "#/components/schemas/AgreementHolder" }, "family": { "$ref": "#/components/schemas/Adviser" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactAddressRelationships/properties/apiAddressClientEntity", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "removed", "path": "/components/schemas/ContactAddressRelationships/properties/contactAddress", "before": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/apiAddressClientEntity", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "removed", "path": "/components/schemas/Error", "before": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "links": { "$ref": "#/components/schemas/ErrorLinks" }, "status": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/ErrorSource" }, "meta": { "$ref": "#/components/schemas/ErrorMeta" } }, "additionalProperties": false } }, { "kind": "changed", "path": "/components/schemas/ErrorDocument/properties/errors/items/$ref", "before": "#/components/schemas/Error", "after": "#/components/schemas/ErrorObject" }, { "kind": "added", "path": "/components/schemas/ErrorDocument/properties/links", "after": { "$ref": "#/components/schemas/TopLevelLinks" } }, { "kind": "added", "path": "/components/schemas/ErrorLinks/properties/type", "after": { "type": "string", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/ErrorMeta", "before": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "nullable": true, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ErrorObject", "after": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "links": { "$ref": "#/components/schemas/ErrorLinks" }, "status": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/ErrorSource" }, "meta": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ErrorSource/properties/header", "after": { "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/RelationshipObject", "after": { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/RelationshipLinks" }, "data": { "$ref": "#/components/schemas/SingleOrManyData`1" }, "meta": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ResourceObject", "after": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "attributes": { "$ref": "#/components/schemas/ResourceObjectAttributes" }, "relationships": { "$ref": "#/components/schemas/ResourceObjectRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ResourceObjectAttributes", "after": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "lid": { "type": "string", "nullable": true }, "links": { "$ref": "#/components/schemas/ResourceLinks" } } } }, { "kind": "added", "path": "/components/schemas/ResourceObjectDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ResourceObject" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ResourceObjectRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ResourceObjectsDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceObject" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/SingleOrManyData`1", "after": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/TopLevelLinks/properties/describedBy", "before": { "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/TopLevelLinks/properties/describedby", "after": { "type": "string", "nullable": true } } ] }, { "commit": "c22a200b6677f80188c9fbb763146aad288087d0", "committedAt": "2022-05-05T16:34:07+10:00", "date": "2022-05-05", "title": "Contact address relationships", "highlights": [ "Contact addresses use a `contacts` relationship. An obsolete address relationship and its supporting schema are removed from the contract." ], "compatibility": "Review contact and contact-address relationship handling against the updated models.", "swaggerSha256": "74566819c2de23cde51087b3c8c46bd836827c201cb8a613b92df6a8aceec562", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [ "ApiAddressClientEntity" ], "changed": [ "ContactAddressRelationships", "ContactRelationships" ] }, "changes": [ { "kind": "removed", "path": "/components/schemas/ApiAddressClientEntity", "before": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "contact": { "$ref": "#/components/schemas/Contact" }, "addressDetails": { "$ref": "#/components/schemas/ContactAddress" } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/ContactAddressRelationships/properties/apiAddressClientEntity", "before": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/ContactAddressRelationships/properties/contacts", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "removed", "path": "/components/schemas/ContactRelationships/properties/apiAddressClientEntity", "before": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } ] }, { "commit": "29dd17dca69feb9501c0062b24ac0ea0029fcfbc", "committedAt": "2022-07-26T17:21:44+10:00", "date": "2022-07-26", "title": "Lead address input", "highlights": [ "Adds the write-only `formattedAddress` lead input, accepting up to 500 characters." ], "swaggerSha256": "f439454481b48833b5737cf46d5a203735c2b072713b414faa93a00e87b93ee9", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "LeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/formattedAddress", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } } ] }, { "commit": "b5c6d704367112fcfa159bd42f669797a724f2e5", "committedAt": "2022-08-04T16:46:45+10:00", "date": "2022-08-04", "title": "Non-empty resource identifiers", "highlights": [ "Resource identifiers require non-empty `id` and `type` values.", "The local `lid` identifier on structured lead address, asset, contact and employment reference models must also be non-empty." ], "compatibility": "Do not send empty strings for resource or local identifiers.", "swaggerSha256": "80711e01c2ca7b3dc1f255e98bb171aad9d3b98fb885addd51679c7b66187271", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "IncludedResource", "LeadAddressReference", "LeadAssetReference", "LeadContactReference", "LeadEmploymentReference", "ResourceIdentifier" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/IncludedResource/properties/type/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/LeadAddressReference/properties/lid/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/LeadAssetReference/properties/lid/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/LeadContactReference/properties/lid/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/LeadEmploymentReference/properties/lid/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/ResourceIdentifier/properties/id/minLength", "after": 1 }, { "kind": "added", "path": "/components/schemas/ResourceIdentifier/properties/type/minLength", "after": 1 } ] }, { "commit": "6981c82e5bdd90c055bfdb3e9eb3abbdbd04b0f5", "committedAt": "2022-08-24T08:59:40+10:00", "date": "2022-08-24", "title": "Lead notification field", "highlights": [ "Adds `sendNotification` to lead and structured lead schemas. This revision marks it read-only; the November release corrects it to an input field." ], "swaggerSha256": "2311edc8edfd6072f1d664af4262bb0992ad0dd050fef55df45eafb96ad1016d", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "LeadAttributes", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/sendNotification", "after": { "type": "boolean", "readOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/sendNotification", "after": { "type": "boolean", "readOnly": true } } ] }, { "commit": "6c941289972b76c2793426d21cdc220bb7519e8f", "committedAt": "2022-10-04T15:06:59+10:00", "date": "2022-10-04", "title": "Additional lead source context", "highlights": [ "Adds `sourceAdditionalDetails`, up to 255 characters, to contact-group, lead and structured lead attributes.", "The lead input models mark this additional source context as write-only." ], "swaggerSha256": "cf19c478fefbc3c799e4e1aaafb2a384bf8e0b7aeeebb88b8838771ae596b179", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "ContactGroupAttributes", "LeadAttributes", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/sourceAdditionalDetails", "after": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/sourceAdditionalDetails", "after": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/sourceAdditionalDetails", "after": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } } ] }, { "commit": "e7b79b60ae5875d60a22f4dbf7760ec18f4bf44f", "committedAt": "2022-11-08T17:27:07+10:00", "date": "2022-11-08", "title": "External integration references and notifications", "highlights": [ "Lead and structured lead inputs gain `externalIntegration`, `externalIntegrationAllowCreate` and `externalReference`.", "The external integration name supports up to 100 characters and the external reference up to 255.", "`sendNotification` is corrected from read-only to write-only, making its intended use as an input explicit." ], "swaggerSha256": "915b6024fe45b4a65f8e8160b34b458a758a675578e2cde6a1341983e9aa9133", "counts": { "operations": 387, "paths": 161, "schemas": 321 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "LeadAttributes", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/externalIntegration", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/externalIntegrationAllowCreate", "after": { "type": "boolean", "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/externalReference", "after": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "removed", "path": "/components/schemas/LeadAttributes/properties/sendNotification/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/sendNotification/writeOnly", "after": true }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/externalIntegration", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/externalIntegrationAllowCreate", "after": { "type": "boolean", "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/externalReference", "after": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "removed", "path": "/components/schemas/StructuredLeadAttributes/properties/sendNotification/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/sendNotification/writeOnly", "after": true } ] }, { "commit": "61cec8a928d1857c89a69eec39e7a6cc1adb9e2e", "committedAt": "2023-05-04T09:24:47+10:00", "date": "2023-05-04", "title": "Write operation availability", "highlights": [ "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.", "swaggerSha256": "6064cd649e7cc03c460860fa13663263c8c012130afa5e1a1e16f71c7456f8b3", "counts": { "operations": 318, "paths": 161, "schemas": 321 }, "operations": { "added": [], "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" ], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [] }, "changes": [ { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references/post", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Creates a new contact external reference with attributes, relationships or both", "operationId": "ContactExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}/delete", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Deletes an existing contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}/patch", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing contact external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1contact/delete", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Removes a contact external reference from a to-many relationship with contacts", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Delete_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1contact/patch", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Performs a complete replacement of a contact relationship on an existing contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Patch_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1contact/post", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Adds contacts to a to-many relationship with an existing contact external reference", "description": "Where `id` is the identifier of the primary contact external reference resource", "operationId": "ContactExternalReferenceRelationship_Post_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1integration/delete", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Removes a contact external reference from a to-many relationship with integrations", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Delete_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1integration/patch", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Performs a complete replacement of a integration relationship on an existing contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Patch_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1integration/post", "before": { "tags": [ "ContactExternalReferences" ], "summary": "Adds integrations to a to-many relationship with an existing contact external reference", "description": "Where `id` is the identifier of the primary contact external reference resource", "operationId": "ContactExternalReferenceRelationship_Post_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups/post", "before": { "tags": [ "ContactGroups" ], "summary": "Creates a new contact group with attributes, relationships or both", "operationId": "ContactGroup_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Deletes an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Updates the attributes and/or relationships of an existing contact group. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1adviser/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Removes a contact group from a to-many relationship with advisers", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Delete_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1adviser/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Performs a complete replacement of a adviser relationship on an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Patch_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1adviser/post", "before": { "tags": [ "ContactGroups" ], "summary": "Adds advisers to a to-many relationship with an existing contact group", "description": "Where `id` is the identifier of the primary contact group resource", "operationId": "ContactGroupRelationship_Post_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1businesses/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Removes a contact group from a to-many relationship with businesses", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Delete_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1businesses/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Performs a complete replacement of a businesses relationship on an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Patch_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1businesses/post", "before": { "tags": [ "ContactGroups" ], "summary": "Adds businesses to a to-many relationship with an existing contact group", "description": "Where `id` is the identifier of the primary contact group resource", "operationId": "ContactGroupRelationship_Post_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1contacts/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Removes a contact group from a to-many relationship with contacts", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Delete_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1contacts/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Performs a complete replacement of a contacts relationship on an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Patch_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1contacts/post", "before": { "tags": [ "ContactGroups" ], "summary": "Adds contacts to a to-many relationship with an existing contact group", "description": "Where `id` is the identifier of the primary contact group resource", "operationId": "ContactGroupRelationship_Post_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Removes a contact group from a to-many relationship with referrers", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Delete_Referrers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Performs a complete replacement of a referrer relationship on an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Patch_Referrers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/post", "before": { "tags": [ "ContactGroups" ], "summary": "Adds referrers to a to-many relationship with an existing contact group", "description": "Where `id` is the identifier of the primary contact group resource", "operationId": "ContactGroupRelationship_Post_Referrers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrerOrganisation/delete", "before": { "tags": [ "ContactGroups" ], "summary": "Removes a contact group from a to-many relationship with referrerOrganisations", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Delete_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrerOrganisation/patch", "before": { "tags": [ "ContactGroups" ], "summary": "Performs a complete replacement of a referrerOrganisation relationship on an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Patch_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrerOrganisation/post", "before": { "tags": [ "ContactGroups" ], "summary": "Adds referrerOrganisations to a to-many relationship with an existing contact group", "description": "Where `id` is the identifier of the primary contact group resource", "operationId": "ContactGroupRelationship_Post_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts/post", "before": { "tags": [ "Contacts" ], "summary": "Creates a new contact with attributes, relationships or both", "operationId": "Contact_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}/delete", "before": { "tags": [ "Contacts" ], "summary": "Deletes an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}/patch", "before": { "tags": [ "Contacts" ], "summary": "Updates the attributes and/or relationships of an existing contact. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactAddress/delete", "before": { "tags": [ "Contacts" ], "summary": "Removes a contact from a to-many relationship with contactAddresses", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Delete_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactAddress/patch", "before": { "tags": [ "Contacts" ], "summary": "Performs a complete replacement of a contactAddress relationship on an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Patch_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactAddress/post", "before": { "tags": [ "Contacts" ], "summary": "Adds contactAddresses to a to-many relationship with an existing contact", "description": "Where `id` is the identifier of the primary contact resource", "operationId": "ContactRelationship_Post_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactGroup/delete", "before": { "tags": [ "Contacts" ], "summary": "Removes a contact from a to-many relationship with contactGroups", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Delete_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactGroup/patch", "before": { "tags": [ "Contacts" ], "summary": "Performs a complete replacement of a contactGroup relationship on an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Patch_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactGroup/post", "before": { "tags": [ "Contacts" ], "summary": "Adds contactGroups to a to-many relationship with an existing contact", "description": "Where `id` is the identifier of the primary contact resource", "operationId": "ContactRelationship_Post_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1deals/delete", "before": { "tags": [ "Contacts" ], "summary": "Removes a contact from a to-many relationship with deals", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Delete_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1deals/patch", "before": { "tags": [ "Contacts" ], "summary": "Performs a complete replacement of a deals relationship on an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Patch_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1deals/post", "before": { "tags": [ "Contacts" ], "summary": "Adds deals to a to-many relationship with an existing contact", "description": "Where `id` is the identifier of the primary contact resource", "operationId": "ContactRelationship_Post_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1externalReferences/delete", "before": { "tags": [ "Contacts" ], "summary": "Removes a contact from a to-many relationship with externalReferences", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Delete_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1externalReferences/patch", "before": { "tags": [ "Contacts" ], "summary": "Performs a complete replacement of a externalReferences relationship on an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Patch_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1externalReferences/post", "before": { "tags": [ "Contacts" ], "summary": "Adds externalReferences to a to-many relationship with an existing contact", "description": "Where `id` is the identifier of the primary contact resource", "operationId": "ContactRelationship_Post_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1ownership/delete", "before": { "tags": [ "Contacts" ], "summary": "Removes a contact from a to-many relationship with ownerships", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Delete_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1ownership/patch", "before": { "tags": [ "Contacts" ], "summary": "Performs a complete replacement of a ownership relationship on an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Patch_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1ownership/post", "before": { "tags": [ "Contacts" ], "summary": "Adds ownerships to a to-many relationship with an existing contact", "description": "Where `id` is the identifier of the primary contact resource", "operationId": "ContactRelationship_Post_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references/post", "before": { "tags": [ "DealExternalReferences" ], "summary": "Creates a new deal external reference with attributes, relationships or both", "operationId": "DealExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}/delete", "before": { "tags": [ "DealExternalReferences" ], "summary": "Deletes an existing deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}/patch", "before": { "tags": [ "DealExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing deal external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1deal/delete", "before": { "tags": [ "DealExternalReferences" ], "summary": "Removes a deal external reference from a to-many relationship with deals", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Delete_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1deal/patch", "before": { "tags": [ "DealExternalReferences" ], "summary": "Performs a complete replacement of a deal relationship on an existing deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Patch_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1deal/post", "before": { "tags": [ "DealExternalReferences" ], "summary": "Adds deals to a to-many relationship with an existing deal external reference", "description": "Where `id` is the identifier of the primary deal external reference resource", "operationId": "DealExternalReferenceRelationship_Post_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1integration/delete", "before": { "tags": [ "DealExternalReferences" ], "summary": "Removes a deal external reference from a to-many relationship with integrations", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Delete_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1integration/patch", "before": { "tags": [ "DealExternalReferences" ], "summary": "Performs a complete replacement of a integration relationship on an existing deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Patch_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1integration/post", "before": { "tags": [ "DealExternalReferences" ], "summary": "Adds integrations to a to-many relationship with an existing deal external reference", "description": "Where `id` is the identifier of the primary deal external reference resource", "operationId": "DealExternalReferenceRelationship_Post_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes/post", "before": { "tags": [ "Notes" ], "summary": "Creates a new deal note with attributes, relationships or both", "operationId": "DealNote_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/delete", "before": { "tags": [ "Notes" ], "summary": "Deletes an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/patch", "before": { "tags": [ "Notes" ], "summary": "Updates the attributes and/or relationships of an existing deal note. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/delete", "before": { "tags": [ "Notes" ], "summary": "Removes a deal note from a to-many relationship with deals", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Delete_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/patch", "before": { "tags": [ "Notes" ], "summary": "Performs a complete replacement of a deal relationship on an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Patch_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/post", "before": { "tags": [ "Notes" ], "summary": "Adds deals to a to-many relationship with an existing deal note", "description": "Where `id` is the identifier of the primary deal note resource", "operationId": "DealNoteRelationship_Post_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations/post", "before": { "tags": [ "Integrations" ], "summary": "Creates a new integration with attributes, relationships or both", "operationId": "Integration_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}/delete", "before": { "tags": [ "Integrations" ], "summary": "Deletes an existing integration", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}/patch", "before": { "tags": [ "Integrations" ], "summary": "Updates the attributes and/or relationships of an existing integration. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1contactExternalReferences/delete", "before": { "tags": [ "Integrations" ], "summary": "Removes a integration from a to-many relationship with contactExternalReferences", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Delete_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1contactExternalReferences/patch", "before": { "tags": [ "Integrations" ], "summary": "Performs a complete replacement of a contactExternalReferences relationship on an existing integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Patch_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1contactExternalReferences/post", "before": { "tags": [ "Integrations" ], "summary": "Adds contactExternalReferences to a to-many relationship with an existing integration", "description": "Where `id` is the identifier of the primary integration resource", "operationId": "IntegrationRelationship_Post_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1dealExternalReferences/delete", "before": { "tags": [ "Integrations" ], "summary": "Removes a integration from a to-many relationship with dealExternalReferences", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Delete_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1dealExternalReferences/patch", "before": { "tags": [ "Integrations" ], "summary": "Performs a complete replacement of a dealExternalReferences relationship on an existing integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Patch_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1dealExternalReferences/post", "before": { "tags": [ "Integrations" ], "summary": "Adds dealExternalReferences to a to-many relationship with an existing integration", "description": "Where `id` is the identifier of the primary integration resource", "operationId": "IntegrationRelationship_Post_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } ] }, { "commit": "c942d4b4946d261d87ba9abdfad09d6843766250", "committedAt": "2023-06-20T17:19:18+10:00", "date": "2023-06-20", "title": "Deal note writes and enquiry source lookups", "highlights": [ "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.", "swaggerSha256": "e0711ae1c5a5853a0099288bb7f85ccb9cfa130e33882417b9563289d10028f3", "counts": { "operations": 332, "paths": 165, "schemas": 321 }, "operations": { "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" ], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "HighLevelSummaryAttributes" ] }, "changes": [ { "kind": "removed", "path": "/components/schemas/HighLevelSummaryAttributes/properties/loanPurpose", "before": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes/post", "after": { "tags": [ "Notes" ], "summary": "Creates a new deal note with attributes, relationships or both", "operationId": "DealNote_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes~1{id}/delete", "after": { "tags": [ "Notes" ], "summary": "Deletes an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes~1{id}/patch", "after": { "tags": [ "Notes" ], "summary": "Updates the attributes and/or relationships of an existing deal note. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/delete", "after": { "tags": [ "Notes" ], "summary": "Removes a deal note from a to-many relationship with deals", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Delete_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/patch", "after": { "tags": [ "Notes" ], "summary": "Performs a complete replacement of a deal relationship on an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Patch_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/post", "after": { "tags": [ "Notes" ], "summary": "Adds deals to a to-many relationship with an existing deal note", "description": "Where `id` is the identifier of the primary deal note resource", "operationId": "DealNoteRelationship_Post_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "Success" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1enquiry-sources", "after": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a collection of enquiry sources", "operationId": "EnquirySources_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EnquirySourcesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySources_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}", "after": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a single enquiry source by id", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySource_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EnquirySourceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySource_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}~1relationships~1{relationshipName}", "after": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a {{{RelationshipNames}}} related to a single enquiry source", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySourceRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySourceRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}~1{relationshipName}", "after": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets {{{RelationshipNames}}} via a single related enquiry source", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySourceRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySourceRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "e1a99679d0509c8dd5df5724f786dd40735aa4de", "committedAt": "2023-10-20T11:05:24+10:00", "date": "2023-10-20", "title": "Referrer models and relationship coverage", "highlights": [ "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.", "swaggerSha256": "70a7f071d38dbe9cb81264d2da9613d2f78a8ce953aa8cc45ace7e461cc592ae", "counts": { "operations": 308, "paths": 153, "schemas": 333 }, "operations": { "added": [], "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}" ], "changed": [ "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" ] }, "schemas": { "added": [ "EnquirySource", "EnquirySourceAttributes", "EnquirySourceDocument", "EnquirySourceEntityType", "EnquirySourceRelationships", "EnquirySourcesDocument", "ReferrerMember", "ReferrerMemberAttributes", "ReferrerMemberDocument", "ReferrerMemberRelationships", "ReferrerMembersDocument", "ReferrerMembersEntityType", "ReferrersEntityType" ], "removed": [ "ReferrerEntityType" ], "changed": [ "AdviserAttributes", "AdviserRelationships", "AgreementHolderRelationships", "BusinessRelationships", "ContactAddressRelationships", "ContactGroupRelationships", "ContactRelationships", "DealScenarioRelationships", "DealStructureImportantDateRelationships", "DealStructureRelationships", "ExpenseCategoryRelationships", "ExpenseTypeRelationships", "HighLevelSummaryRelationships", "IncludedResource", "IncomeCategoryRelationships", "IncomeTypeRelationships", "LiabilityCategoryRelationships", "LiabilityTypeRelationships", "OrganisationRelationships", "OwnerRelationships", "Referrer", "ReferrerAttributes", "ReferrerOrganisationRelationships", "ReferrerRelationships" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AdviserAttributes/properties/isBrokerWebPublic", "after": { "type": "boolean", "readOnly": true } }, { "kind": "removed", "path": "/components/schemas/AdviserRelationships/properties/addresses/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/AdviserRelationships/properties/addresses/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/AdviserRelationships/properties/addresses/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/AgreementHolderRelationships/properties/organisation", "before": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "removed", "path": "/components/schemas/BusinessRelationships/properties/employments/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/BusinessRelationships/properties/employments/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/BusinessRelationships/properties/employments/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ContactAddressRelationships/properties/contacts/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/ContactAddressRelationships/properties/contacts/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ContactAddressRelationships/properties/contacts/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ContactRelationships/properties/contactAddress/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/contactAddress/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/contactAddress/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ContactRelationships/properties/employments/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/employments/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ContactRelationships/properties/employments/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/DealScenarioRelationships/properties/highLevelSummary/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/DealScenarioRelationships/properties/highLevelSummary/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/DealScenarioRelationships/properties/highLevelSummary/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/DealStructureImportantDateRelationships/properties/dealStructure/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDateRelationships/properties/dealStructure/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDateRelationships/properties/dealStructure/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/DealStructureRelationships/properties/deal/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/DealStructureRelationships/properties/deal/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/DealStructureRelationships/properties/deal/writeOnly", "after": true }, { "kind": "added", "path": "/components/schemas/EnquirySource", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/EnquirySourceEntityType" }, "id": { "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/EnquirySourceAttributes" }, "relationships": { "$ref": "#/components/schemas/EnquirySourceRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/EnquirySourceAttributes", "after": { "type": "object", "properties": { "sourceCategoryId": { "type": "integer", "format": "int32", "readOnly": true }, "sourceCategoryName": { "type": "string", "nullable": true, "readOnly": true }, "sourceId": { "type": "integer", "format": "int32", "readOnly": true }, "sourceName": { "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/EnquirySourceDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/EnquirySource" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/EnquirySourceEntityType", "after": { "enum": [ "enquiry-source" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/EnquirySourceRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/EnquirySourcesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnquirySource" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "removed", "path": "/components/schemas/ExpenseCategoryRelationships/properties/expenseTypes/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryRelationships/properties/expenseTypes/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryRelationships/properties/expenseTypes/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ExpenseTypeRelationships/properties/expenseCategory/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/ExpenseTypeRelationships/properties/expenseCategory/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ExpenseTypeRelationships/properties/expenseCategory/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/HighLevelSummaryRelationships/properties/dealScenario/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/HighLevelSummaryRelationships/properties/dealScenario/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/HighLevelSummaryRelationships/properties/dealScenario/writeOnly", "after": true }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/enquiry-source", "after": "#/components/schemas/EnquirySource" }, { "kind": "removed", "path": "/components/schemas/IncludedResource/discriminator/mapping/referrer", "before": "#/components/schemas/Referrer" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/referrer-members", "after": "#/components/schemas/ReferrerMember" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/referrers", "after": "#/components/schemas/Referrer" }, { "kind": "removed", "path": "/components/schemas/IncomeCategoryRelationships/properties/incomeTypes/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/IncomeCategoryRelationships/properties/incomeTypes/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/IncomeCategoryRelationships/properties/incomeTypes/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/IncomeTypeRelationships/properties/incomeCategory/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/IncomeTypeRelationships/properties/incomeCategory/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/IncomeTypeRelationships/properties/incomeCategory/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/LiabilityCategoryRelationships/properties/liabilityTypes/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryRelationships/properties/liabilityTypes/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryRelationships/properties/liabilityTypes/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/LiabilityTypeRelationships/properties/liabilityCategory/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/LiabilityTypeRelationships/properties/liabilityCategory/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/LiabilityTypeRelationships/properties/liabilityCategory/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/OrganisationRelationships/properties/addresses/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/OrganisationRelationships/properties/addresses/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/OrganisationRelationships/properties/addresses/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/OrganisationRelationships/properties/advisers", "before": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "removed", "path": "/components/schemas/OwnerRelationships/properties/asset/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/asset/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/asset/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/OwnerRelationships/properties/expense/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/expense/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/expense/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/OwnerRelationships/properties/income/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/income/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/income/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/OwnerRelationships/properties/liability/$ref", "before": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/liability/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "added", "path": "/components/schemas/OwnerRelationships/properties/liability/writeOnly", "after": true }, { "kind": "changed", "path": "/components/schemas/Referrer/properties/type/$ref", "before": "#/components/schemas/ReferrerEntityType", "after": "#/components/schemas/ReferrersEntityType" }, { "kind": "removed", "path": "/components/schemas/ReferrerAttributes/properties/referrerName/maxLength", "before": 255 }, { "kind": "removed", "path": "/components/schemas/ReferrerAttributes/properties/referrerName/minLength", "before": 0 }, { "kind": "added", "path": "/components/schemas/ReferrerAttributes/properties/referrerName/readOnly", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerAttributes/properties/referrerOrganisationName", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "removed", "path": "/components/schemas/ReferrerEntityType", "before": { "enum": [ "referrer" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/ReferrerMember", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ReferrerMembersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ReferrerMemberAttributes" }, "relationships": { "$ref": "#/components/schemas/ReferrerMemberRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ReferrerMemberAttributes", "after": { "type": "object", "properties": { "referrerName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true } } } }, { "kind": "added", "path": "/components/schemas/ReferrerMemberDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ReferrerMember" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ReferrerMemberRelationships", "after": { "type": "object", "properties": { "contactGroups": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ReferrerMembersDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerMember" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ReferrerMembersEntityType", "after": { "enum": [ "referrer-members" ], "type": "string" } }, { "kind": "removed", "path": "/components/schemas/ReferrerOrganisationRelationships/properties/contactGroups/$ref", "before": "#/components/schemas/RelationshipsMultipleDocument" }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationRelationships/properties/contactGroups/allOf", "after": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ] }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationRelationships/properties/contactGroups/writeOnly", "after": true }, { "kind": "removed", "path": "/components/schemas/ReferrerRelationships/properties", "before": { "contactGroups": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, { "kind": "added", "path": "/components/schemas/ReferrersEntityType", "after": { "enum": [ "referrers" ], "type": "string" } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets a {{{RelationshipNames}}} related to a single asset category", "description": "Where `id` is the identifier of the asset category", "operationId": "AssetCategoryRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategoryRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-categories~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets {{{RelationshipNames}}} via a single related asset category", "description": "Where `id` is the identifier of the asset category", "operationId": "AssetCategoryRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategoryRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets a {{{RelationshipNames}}} related to a single asset sub-type", "description": "Where `id` is the identifier of the asset sub-type", "operationId": "AssetSubTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets {{{RelationshipNames}}} via a single related asset sub-type", "description": "Where `id` is the identifier of the asset sub-type", "operationId": "AssetSubTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-types~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets a {{{RelationshipNames}}} related to a single asset type", "description": "Where `id` is the identifier of the asset type", "operationId": "AssetTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1asset-types~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets {{{RelationshipNames}}} via a single related asset type", "description": "Where `id` is the identifier of the asset type", "operationId": "AssetTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/get/operationId", "before": "ContactGroupRelated_Get_Referrers", "after": "ContactGroupRelated_Get_ReferrerMembers" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ReferrersDocument", "after": "#/components/schemas/ReferrerMembersDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/head/operationId", "before": "ContactGroupRelated_Head_Referrers", "after": "ContactGroupRelated_Head_ReferrerMembers" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/get/operationId", "before": "ContactGroupRelationship_Get_Referrers", "after": "ContactGroupRelationship_Get_ReferrerMembers" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/head/operationId", "before": "ContactGroupRelationship_Get_Head_Referrers", "after": "ContactGroupRelationship_Get_Head_ReferrerMembers" }, { "kind": "removed", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a {{{RelationshipNames}}} related to a single enquiry source", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySourceRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySourceRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets {{{RelationshipNames}}} via a single related enquiry source", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySourceRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySourceRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1property-types~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a {{{RelationshipNames}}} related to a single property type", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyTypeRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypeRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1property-types~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets {{{RelationshipNames}}} via a single related property type", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyTypeRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypeRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1referrers~1{id}~1relationships~1{relationshipName}", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets a {{{RelationshipNames}}} related to a single referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ReferrerRelationship_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ReferrerRelationship_Get_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1referrers~1{id}~1{relationshipName}", "before": { "get": { "tags": [ "Referrers" ], "summary": "Gets {{{RelationshipNames}}} via a single related referrer", "description": "Where `id` is the identifier of the referrer", "operationId": "ReferrerRelated_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": {} } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ReferrerRelated_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "ee7239233d769f8a50f9dab2947e7d6c0ab05ac9", "committedAt": "2024-01-18T09:26:28+10:00", "date": "2024-01-18", "title": "Deal note authorship", "highlights": [ "Deal notes gain the read-only `writtenBy` field, supporting up to 500 characters.", "Removes collection-level GET and HEAD operations for `/jsonapi/deal-notes`.", "Refreshes supporting schemas, including geometry types and the agreement-holder organisation relationship." ], "compatibility": "Use the available related-resource or individual-note operations instead of relying on the removed collection routes.", "swaggerSha256": "83ed857046e1da8f47a511e71aae6e3b9ca3acfe17ff1ccf0059787cab05fca0", "counts": { "operations": 306, "paths": 153, "schemas": 347 }, "operations": { "added": [], "removed": [ "GET /jsonapi/deal-notes", "HEAD /jsonapi/deal-notes" ], "changed": [ "DELETE /jsonapi/deal-notes/{id}", "DELETE /jsonapi/deal-notes/{id}/relationships/deal", "GET /jsonapi/deal-notes/{id}", "GET /jsonapi/deal-notes/{id}/deal", "GET /jsonapi/deal-notes/{id}/relationships/deal", "HEAD /jsonapi/deal-notes/{id}", "HEAD /jsonapi/deal-notes/{id}/deal", "HEAD /jsonapi/deal-notes/{id}/relationships/deal", "PATCH /jsonapi/deal-notes/{id}", "PATCH /jsonapi/deal-notes/{id}/relationships/deal", "POST /jsonapi/deal-notes", "POST /jsonapi/deal-notes/{id}/relationships/deal" ] }, "schemas": { "added": [ "Coordinate", "CoordinateEqualityComparer", "CoordinateSequence", "CoordinateSequenceFactory", "Dimension", "Envelope", "Geometry", "GeometryFactory", "GeometryOverlay", "NtsGeometryServices", "OgcGeometryType", "Ordinates", "Point", "PrecisionModel", "PrecisionModels" ], "removed": [ "WorkbenchLogType" ], "changed": [ "AgreementHolderRelationships", "DealNoteAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AgreementHolderRelationships/properties/organisation", "after": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/Coordinate", "after": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" }, "m": { "type": "number", "format": "double" }, "coordinateValue": { "$ref": "#/components/schemas/Coordinate" }, "isValid": { "type": "boolean", "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/CoordinateEqualityComparer", "after": { "type": "object", "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/CoordinateSequence", "after": { "type": "object", "properties": { "dimension": { "type": "integer", "format": "int32", "readOnly": true }, "measures": { "type": "integer", "format": "int32", "readOnly": true }, "spatial": { "type": "integer", "format": "int32", "readOnly": true }, "ordinates": { "$ref": "#/components/schemas/Ordinates" }, "hasZ": { "type": "boolean", "readOnly": true }, "hasM": { "type": "boolean", "readOnly": true }, "zOrdinateIndex": { "type": "integer", "format": "int32", "readOnly": true }, "mOrdinateIndex": { "type": "integer", "format": "int32", "readOnly": true }, "first": { "$ref": "#/components/schemas/Coordinate" }, "last": { "$ref": "#/components/schemas/Coordinate" }, "count": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/CoordinateSequenceFactory", "after": { "type": "object", "properties": { "ordinates": { "$ref": "#/components/schemas/Ordinates" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealNoteAttributes/properties/writtenBy", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Dimension", "after": { "enum": [ "P", "Curve", "A", "Collapse", "Dontcare", "True", "Unknown" ], "type": "string", "x-ms-enum": { "name": "Dimension", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/Envelope", "after": { "type": "object", "properties": { "isNull": { "type": "boolean", "readOnly": true }, "width": { "type": "number", "format": "double", "readOnly": true }, "height": { "type": "number", "format": "double", "readOnly": true }, "diameter": { "type": "number", "format": "double", "readOnly": true }, "minX": { "type": "number", "format": "double", "readOnly": true }, "maxX": { "type": "number", "format": "double", "readOnly": true }, "minY": { "type": "number", "format": "double", "readOnly": true }, "maxY": { "type": "number", "format": "double", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "minExtent": { "type": "number", "format": "double", "readOnly": true }, "maxExtent": { "type": "number", "format": "double", "readOnly": true }, "centre": { "$ref": "#/components/schemas/Coordinate" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/Geometry", "after": { "type": "object", "properties": { "factory": { "$ref": "#/components/schemas/GeometryFactory" }, "userData": { "nullable": true }, "srid": { "type": "integer", "format": "int32" }, "geometryType": { "type": "string", "nullable": true, "readOnly": true }, "ogcGeometryType": { "$ref": "#/components/schemas/OgcGeometryType" }, "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "coordinate": { "$ref": "#/components/schemas/Coordinate" }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinate" }, "nullable": true, "readOnly": true }, "numPoints": { "type": "integer", "format": "int32", "readOnly": true }, "numGeometries": { "type": "integer", "format": "int32", "readOnly": true }, "isSimple": { "type": "boolean", "readOnly": true }, "isValid": { "type": "boolean", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "length": { "type": "number", "format": "double", "readOnly": true }, "centroid": { "$ref": "#/components/schemas/Point" }, "interiorPoint": { "$ref": "#/components/schemas/Point" }, "pointOnSurface": { "$ref": "#/components/schemas/Point" }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "boundary": { "$ref": "#/components/schemas/Geometry" }, "boundaryDimension": { "$ref": "#/components/schemas/Dimension" }, "envelope": { "$ref": "#/components/schemas/Geometry" }, "envelopeInternal": { "$ref": "#/components/schemas/Envelope" }, "isRectangle": { "type": "boolean", "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/GeometryFactory", "after": { "type": "object", "properties": { "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "coordinateSequenceFactory": { "$ref": "#/components/schemas/CoordinateSequenceFactory" }, "srid": { "type": "integer", "format": "int32", "readOnly": true }, "geometryServices": { "$ref": "#/components/schemas/NtsGeometryServices" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/GeometryOverlay", "after": { "type": "object", "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/NtsGeometryServices", "after": { "type": "object", "properties": { "geometryOverlay": { "$ref": "#/components/schemas/GeometryOverlay" }, "coordinateEqualityComparer": { "$ref": "#/components/schemas/CoordinateEqualityComparer" }, "defaultSRID": { "type": "integer", "format": "int32", "readOnly": true }, "defaultCoordinateSequenceFactory": { "$ref": "#/components/schemas/CoordinateSequenceFactory" }, "defaultPrecisionModel": { "$ref": "#/components/schemas/PrecisionModel" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/OgcGeometryType", "after": { "enum": [ "Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", "MultiPolygon", "GeometryCollection", "CircularString", "CompoundCurve", "CurvePolygon", "MultiCurve", "MultiSurface", "Curve", "Surface", "PolyhedralSurface", "TIN" ], "type": "string", "x-ms-enum": { "name": "OgcGeometryType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/Ordinates", "after": { "enum": [ "None", "X", "Y", "XY", "Spatial3", "XYZ", "Spatial4", "Spatial5", "Spatial6", "Spatial7", "Spatial8", "Spatial9", "Spatial10", "Spatial11", "Spatial12", "Spatial13", "Spatial14", "Spatial15", "Spatial16", "AllSpatialOrdinates", "Measure1", "XYM", "XYZM", "Measure2", "Measure3", "Measure4", "Measure5", "Measure6", "Measure7", "Measure8", "Measure9", "Measure10", "Measure11", "Measure12", "Measure13", "Measure14", "Measure15", "Measure16", "AllMeasureOrdinates", "AllOrdinates" ], "type": "string", "x-ms-enum": { "name": "Ordinates", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/Point", "after": { "type": "object", "properties": { "factory": { "$ref": "#/components/schemas/GeometryFactory" }, "userData": { "nullable": true }, "srid": { "type": "integer", "format": "int32" }, "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "numGeometries": { "type": "integer", "format": "int32", "readOnly": true }, "isSimple": { "type": "boolean", "readOnly": true }, "isValid": { "type": "boolean", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "length": { "type": "number", "format": "double", "readOnly": true }, "centroid": { "$ref": "#/components/schemas/Point" }, "interiorPoint": { "$ref": "#/components/schemas/Point" }, "pointOnSurface": { "$ref": "#/components/schemas/Point" }, "envelope": { "$ref": "#/components/schemas/Geometry" }, "envelopeInternal": { "$ref": "#/components/schemas/Envelope" }, "isRectangle": { "type": "boolean", "readOnly": true }, "coordinateSequence": { "$ref": "#/components/schemas/CoordinateSequence" }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinate" }, "nullable": true, "readOnly": true }, "numPoints": { "type": "integer", "format": "int32", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "boundaryDimension": { "$ref": "#/components/schemas/Dimension" }, "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "coordinate": { "$ref": "#/components/schemas/Coordinate" }, "geometryType": { "type": "string", "nullable": true, "readOnly": true }, "ogcGeometryType": { "$ref": "#/components/schemas/OgcGeometryType" }, "boundary": { "$ref": "#/components/schemas/Geometry" }, "z": { "type": "number", "format": "double" }, "m": { "type": "number", "format": "double" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/PrecisionModel", "after": { "type": "object", "properties": { "isFloating": { "type": "boolean", "readOnly": true }, "maximumSignificantDigits": { "type": "integer", "format": "int32", "readOnly": true }, "scale": { "type": "number", "format": "double" }, "gridSize": { "type": "number", "format": "double", "readOnly": true }, "precisionModelType": { "$ref": "#/components/schemas/PrecisionModels" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/PrecisionModels", "after": { "enum": [ "Floating", "FloatingSingle", "Fixed" ], "type": "string", "x-ms-enum": { "name": "PrecisionModels", "modelAsString": true } } }, { "kind": "removed", "path": "/components/schemas/WorkbenchLogType", "before": { "enum": [ "Email", "Mail", "Notes", "RequirementAdd", "RequirementCompleted", "RequirementUnticked", "RequirementUpdated", "RequirementDeleted", "NextWorkDate" ], "type": "string", "x-ms-enum": { "name": "WorkbenchLogType", "modelAsString": true } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes/get", "before": { "tags": [ "Notes" ], "summary": "Gets a collection of notes on deals", "operationId": "DealNotes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNotesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes/head", "before": { "tags": [ "Notes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealNotes_Head", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes/post/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/delete/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/get/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/head/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/patch/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1deal/get/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1deal/head/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/delete/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/get/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/head/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/patch/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/post/tags", "before": [ "Notes" ], "after": [ "DealNotes" ] } ] }, { "commit": "1729c12453ad674879f889b5f0105589dcc10c85", "committedAt": "2024-11-11T16:08:29+10:00", "date": "2024-11-11", "title": "Lead naming and referral context", "highlights": [ "Lead and structured lead inputs gain `dealName` and `sourceReferrerId`.", "Referrer identifiers no longer carry the numeric-only constraint. Organisations gain the read-only `isBrokerSearchVisible` field.", "Supporting geometry enum values change, including `Point`, `Surface`, `False`, `Z` and `M`." ], "compatibility": "Treat referrer identifiers as opaque strings. Review generated enum mappings if your client exposes geometry schemas.", "swaggerSha256": "2c063ca964ce97f752aa158d60dba1cb850408d3b604a6ec404f1a5fd2e796a9", "counts": { "operations": 306, "paths": 153, "schemas": 347 }, "operations": { "added": [], "removed": [], "changed": [ "GET /jsonapi/referrers/{id}", "HEAD /jsonapi/adviser-details", "HEAD /jsonapi/adviser-details/{id}", "HEAD /jsonapi/adviser-details/{id}/adviser", "HEAD /jsonapi/adviser-details/{id}/relationships/adviser", "HEAD /jsonapi/advisers", "HEAD /jsonapi/advisers/{id}", "HEAD /jsonapi/advisers/{id}/addresses", "HEAD /jsonapi/advisers/{id}/adviserDetails", "HEAD /jsonapi/advisers/{id}/agreementHolders", "HEAD /jsonapi/advisers/{id}/contactGroups", "HEAD /jsonapi/advisers/{id}/organisation", "HEAD /jsonapi/advisers/{id}/relationships/addresses", "HEAD /jsonapi/advisers/{id}/relationships/adviserDetails", "HEAD /jsonapi/advisers/{id}/relationships/agreementHolders", "HEAD /jsonapi/advisers/{id}/relationships/contactGroups", "HEAD /jsonapi/advisers/{id}/relationships/organisation", "HEAD /jsonapi/asset-categories", "HEAD /jsonapi/asset-categories/{id}", "HEAD /jsonapi/asset-sub-types", "HEAD /jsonapi/asset-sub-types/{id}", "HEAD /jsonapi/asset-types", "HEAD /jsonapi/asset-types/{id}", "HEAD /jsonapi/assets", "HEAD /jsonapi/assets/{id}", "HEAD /jsonapi/assets/{id}/addresses", "HEAD /jsonapi/assets/{id}/ownership", "HEAD /jsonapi/assets/{id}/relationships/addresses", "HEAD /jsonapi/assets/{id}/relationships/ownership", "HEAD /jsonapi/contact-external-references", "HEAD /jsonapi/contact-external-references/{id}", "HEAD /jsonapi/contact-external-references/{id}/contact", "HEAD /jsonapi/contact-external-references/{id}/integration", "HEAD /jsonapi/contact-external-references/{id}/relationships/contact", "HEAD /jsonapi/contact-external-references/{id}/relationships/integration", "HEAD /jsonapi/contact-groups", "HEAD /jsonapi/contact-groups/{id}", "HEAD /jsonapi/contact-groups/{id}/adviser", "HEAD /jsonapi/contact-groups/{id}/businesses", "HEAD /jsonapi/contact-groups/{id}/contacts", "HEAD /jsonapi/contact-groups/{id}/referrer", "HEAD /jsonapi/contact-groups/{id}/referrerOrganisation", "HEAD /jsonapi/contact-groups/{id}/relationships/adviser", "HEAD /jsonapi/contact-groups/{id}/relationships/businesses", "HEAD /jsonapi/contact-groups/{id}/relationships/contacts", "HEAD /jsonapi/contact-groups/{id}/relationships/referrer", "HEAD /jsonapi/contact-groups/{id}/relationships/referrerOrganisation", "HEAD /jsonapi/contacts", "HEAD /jsonapi/contacts/{id}", "HEAD /jsonapi/contacts/{id}/contactAddress", "HEAD /jsonapi/contacts/{id}/contactGroup", "HEAD /jsonapi/contacts/{id}/deals", "HEAD /jsonapi/contacts/{id}/externalReferences", "HEAD /jsonapi/contacts/{id}/ownership", "HEAD /jsonapi/contacts/{id}/relationships/contactAddress", "HEAD /jsonapi/contacts/{id}/relationships/contactGroup", "HEAD /jsonapi/contacts/{id}/relationships/deals", "HEAD /jsonapi/contacts/{id}/relationships/externalReferences", "HEAD /jsonapi/contacts/{id}/relationships/ownership", "HEAD /jsonapi/deal-external-references", "HEAD /jsonapi/deal-external-references/{id}", "HEAD /jsonapi/deal-external-references/{id}/deal", "HEAD /jsonapi/deal-external-references/{id}/integration", "HEAD /jsonapi/deal-external-references/{id}/relationships/deal", "HEAD /jsonapi/deal-external-references/{id}/relationships/integration", "HEAD /jsonapi/deal-notes/{id}", "HEAD /jsonapi/deal-notes/{id}/deal", "HEAD /jsonapi/deal-notes/{id}/relationships/deal", "HEAD /jsonapi/deal-participants", "HEAD /jsonapi/deal-participants/{id}", "HEAD /jsonapi/deal-participants/{id}/contact", "HEAD /jsonapi/deal-participants/{id}/deal", "HEAD /jsonapi/deal-participants/{id}/relationships/contact", "HEAD /jsonapi/deal-participants/{id}/relationships/deal", "HEAD /jsonapi/deals", "HEAD /jsonapi/deals/{id}", "HEAD /jsonapi/deals/{id}/adviser", "HEAD /jsonapi/deals/{id}/contacts", "HEAD /jsonapi/deals/{id}/dealNotes", "HEAD /jsonapi/deals/{id}/dealScenario", "HEAD /jsonapi/deals/{id}/dealStructures", "HEAD /jsonapi/deals/{id}/externalReferences", "HEAD /jsonapi/deals/{id}/importantDates", "HEAD /jsonapi/deals/{id}/participants", "HEAD /jsonapi/deals/{id}/relationships/adviser", "HEAD /jsonapi/deals/{id}/relationships/contacts", "HEAD /jsonapi/deals/{id}/relationships/dealNotes", "HEAD /jsonapi/deals/{id}/relationships/dealScenario", "HEAD /jsonapi/deals/{id}/relationships/dealStructures", "HEAD /jsonapi/deals/{id}/relationships/externalReferences", "HEAD /jsonapi/deals/{id}/relationships/importantDates", "HEAD /jsonapi/deals/{id}/relationships/participants", "HEAD /jsonapi/enquiry-sources", "HEAD /jsonapi/enquiry-sources/{id}", "HEAD /jsonapi/expense-categories", "HEAD /jsonapi/expense-categories/{id}", "HEAD /jsonapi/expense-categories/{id}/expenseTypes", "HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes", "HEAD /jsonapi/expense-types", "HEAD /jsonapi/expense-types/{id}", "HEAD /jsonapi/expense-types/{id}/expenseCategory", "HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory", "HEAD /jsonapi/expenses", "HEAD /jsonapi/expenses/{id}", "HEAD /jsonapi/expenses/{id}/ownership", "HEAD /jsonapi/expenses/{id}/relationships/ownership", "HEAD /jsonapi/income-categories", "HEAD /jsonapi/income-categories/{id}", "HEAD /jsonapi/income-categories/{id}/incomeTypes", "HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes", "HEAD /jsonapi/income-types", "HEAD /jsonapi/income-types/{id}", "HEAD /jsonapi/income-types/{id}/incomeCategory", "HEAD /jsonapi/income-types/{id}/relationships/incomeCategory", "HEAD /jsonapi/incomes", "HEAD /jsonapi/incomes/{id}", "HEAD /jsonapi/incomes/{id}/linkedAsset", "HEAD /jsonapi/incomes/{id}/ownership", "HEAD /jsonapi/incomes/{id}/relationships/linkedAsset", "HEAD /jsonapi/incomes/{id}/relationships/ownership", "HEAD /jsonapi/integrations", "HEAD /jsonapi/integrations/{id}", "HEAD /jsonapi/integrations/{id}/contactExternalReferences", "HEAD /jsonapi/integrations/{id}/dealExternalReferences", "HEAD /jsonapi/integrations/{id}/relationships/contactExternalReferences", "HEAD /jsonapi/integrations/{id}/relationships/dealExternalReferences", "HEAD /jsonapi/liabilities", "HEAD /jsonapi/liabilities/{id}", "HEAD /jsonapi/liabilities/{id}/linkedAsset", "HEAD /jsonapi/liabilities/{id}/ownership", "HEAD /jsonapi/liabilities/{id}/relationships/linkedAsset", "HEAD /jsonapi/liabilities/{id}/relationships/ownership", "HEAD /jsonapi/liability-categories", "HEAD /jsonapi/liability-categories/{id}", "HEAD /jsonapi/liability-categories/{id}/liabilityTypes", "HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes", "HEAD /jsonapi/liability-types", "HEAD /jsonapi/liability-types/{id}", "HEAD /jsonapi/liability-types/{id}/liabilityCategory", "HEAD /jsonapi/liability-types/{id}/relationships/liabilityCategory", "HEAD /jsonapi/organisations", "HEAD /jsonapi/organisations/{id}", "HEAD /jsonapi/organisations/{id}/addresses", "HEAD /jsonapi/organisations/{id}/relationships/addresses", "HEAD /jsonapi/property-types", "HEAD /jsonapi/property-types/{id}", "HEAD /jsonapi/referrers", "HEAD /jsonapi/referrers/{id}", "PATCH /jsonapi/deal-notes/{id}/relationships/deal", "POST /jsonapi/deal-notes/{id}/relationships/deal" ] }, "schemas": { "added": [], "removed": [], "changed": [ "Dimension", "LeadAttributes", "Ordinates", "OrganisationAttributes", "Referrer", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "changed", "path": "/components/schemas/Dimension/enum", "before": [ "P", "Curve", "A", "Collapse", "Dontcare", "True", "Unknown" ], "after": [ "Point", "Curve", "Surface", "Collapse", "Dontcare", "True", "False" ] }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/dealName", "after": { "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/sourceReferrerId", "after": { "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "changed", "path": "/components/schemas/Ordinates/enum", "before": [ "None", "X", "Y", "XY", "Spatial3", "XYZ", "Spatial4", "Spatial5", "Spatial6", "Spatial7", "Spatial8", "Spatial9", "Spatial10", "Spatial11", "Spatial12", "Spatial13", "Spatial14", "Spatial15", "Spatial16", "AllSpatialOrdinates", "Measure1", "XYM", "XYZM", "Measure2", "Measure3", "Measure4", "Measure5", "Measure6", "Measure7", "Measure8", "Measure9", "Measure10", "Measure11", "Measure12", "Measure13", "Measure14", "Measure15", "Measure16", "AllMeasureOrdinates", "AllOrdinates" ], "after": [ "None", "X", "Y", "XY", "Z", "XYZ", "Spatial4", "Spatial5", "Spatial6", "Spatial7", "Spatial8", "Spatial9", "Spatial10", "Spatial11", "Spatial12", "Spatial13", "Spatial14", "Spatial15", "Spatial16", "AllSpatialOrdinates", "M", "XYM", "XYZM", "Measure2", "Measure3", "Measure4", "Measure5", "Measure6", "Measure7", "Measure8", "Measure9", "Measure10", "Measure11", "Measure12", "Measure13", "Measure14", "Measure15", "Measure16", "AllMeasureOrdinates", "AllOrdinates" ] }, { "kind": "added", "path": "/components/schemas/OrganisationAttributes/properties/isBrokerSearchVisible", "after": { "type": "boolean", "nullable": true, "readOnly": true } }, { "kind": "removed", "path": "/components/schemas/Referrer/properties/id/pattern", "before": "^[1-9]\\d*$" }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/dealName", "after": { "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/sourceReferrerId", "after": { "type": "string", "nullable": true, "writeOnly": true } }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1agreementHolders/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1contactGroups/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1adviserDetails/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1agreementHolders/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1contactGroups/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1organisation/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-categories/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-categories~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-sub-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-sub-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1asset-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets~1{id}~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets~1{id}~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1assets~1{id}~1relationships~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1contact/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1integration/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1contact/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1integration/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1businesses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1contacts/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrerOrganisation/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1businesses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1contacts/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrerOrganisation/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1contactAddress/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1contactGroup/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1deals/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1externalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactAddress/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactGroup/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1deals/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1externalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1integration/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1integration/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/patch/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/post/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1contacts/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealNotes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealStructures/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1externalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1importantDates/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1participants/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1contacts/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealNotes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealStructures/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1externalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1importantDates/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1participants/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1enquiry-sources/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1enquiry-sources~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-categories/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-categories~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1expenseTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-categories~1{id}~1relationships~1expenseTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}~1relationships~1expenseCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expenses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expenses~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expenses~1{id}~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expenses~1{id}~1relationships~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-categories/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-categories~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-categories~1{id}~1incomeTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-categories~1{id}~1relationships~1incomeTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}~1relationships~1incomeCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations~1{id}~1contactExternalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations~1{id}~1dealExternalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1contactExternalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1integrations~1{id}~1relationships~1dealExternalReferences/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1ownership/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-categories/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-categories~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1liabilityTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-categories~1{id}~1relationships~1liabilityTypes/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilityCategory/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1organisations/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1organisations~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1organisations~1{id}~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1organisations~1{id}~1relationships~1addresses/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1property-types/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1property-types~1{id}/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1referrers/head/responses/200/description", "before": "Success", "after": "OK" }, { "kind": "changed", "path": "/paths/~1jsonapi~1referrers~1{id}/get/parameters", "before": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "after": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1referrers~1{id}/head/parameters", "before": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "after": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, { "kind": "changed", "path": "/paths/~1jsonapi~1referrers~1{id}/head/responses/200/description", "before": "Success", "after": "OK" } ] }, { "commit": "d8ea6b242d2546a1bb1b686ee76e2c8df128bc6b", "committedAt": "2024-11-15T16:27:06+10:00", "date": "2024-11-15", "title": "Existing contact matching for leads", "highlights": [ "Lead input gains `contactMatchExisting` to select how an existing contact is matched.", "The available matching combinations are email; email and mobile; email and name; email, mobile and name; email and date of birth; or email, date of birth and name." ], "swaggerSha256": "be776e6c10c45d64a350d110693b6ffd547d2898008732236607d01cfe496489", "counts": { "operations": 306, "paths": 153, "schemas": 348 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [ "ExistingContactCheck" ], "removed": [], "changed": [ "LeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/ExistingContactCheck", "after": { "enum": [ "Email", "EmailMobile", "EmailName", "EmailMobileName", "EmailDateOfBirth", "EmailDateOfBirthName" ], "type": "string", "x-ms-enum": { "name": "ExistingContactCheck", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/contactMatchExisting", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ExistingContactCheck" } ], "writeOnly": true } } ] }, { "commit": "a6172294eb879a3642124f65cd6c496b51b90890", "committedAt": "2025-01-20T10:05:38+10:00", "date": "2025-01-20", "title": "Deal securities and client review month", "highlights": [ "Adds 20 GET and HEAD operations covering deal securities, their related resources and relationship data, and the securities attached to a deal.", "Contact groups gain the nullable `reviewMonth` field for client review planning." ], "swaggerSha256": "6645794bbe89a1406458a8a3d7a0ce3f8506e58969427e641da05fac89e2c643", "counts": { "operations": 326, "paths": 163, "schemas": 368 }, "operations": { "added": [ "GET /jsonapi/deal-securities", "GET /jsonapi/deal-securities/{id}", "GET /jsonapi/deal-securities/{id}/asset", "GET /jsonapi/deal-securities/{id}/ownership", "GET /jsonapi/deal-securities/{id}/relationships/asset", "GET /jsonapi/deal-securities/{id}/relationships/ownership", "GET /jsonapi/deal-securities/{id}/relationships/titleIdentifications", "GET /jsonapi/deal-securities/{id}/titleIdentifications", "GET /jsonapi/deals/{id}/loanSecurities", "GET /jsonapi/deals/{id}/relationships/loanSecurities", "HEAD /jsonapi/deal-securities", "HEAD /jsonapi/deal-securities/{id}", "HEAD /jsonapi/deal-securities/{id}/asset", "HEAD /jsonapi/deal-securities/{id}/ownership", "HEAD /jsonapi/deal-securities/{id}/relationships/asset", "HEAD /jsonapi/deal-securities/{id}/relationships/ownership", "HEAD /jsonapi/deal-securities/{id}/relationships/titleIdentifications", "HEAD /jsonapi/deal-securities/{id}/titleIdentifications", "HEAD /jsonapi/deals/{id}/loanSecurities", "HEAD /jsonapi/deals/{id}/relationships/loanSecurities" ], "removed": [], "changed": [] }, "schemas": { "added": [ "ApiLoanSecurity", "ContactAccessType", "DealSecuritiesDocument", "DealSecuritiesEntityType", "DealSecurity", "DealSecurityAttributes", "DealSecurityDocument", "DealSecurityOwnership", "DealSecurityOwnershipAttributes", "DealSecurityOwnershipDocument", "DealSecurityOwnershipEntityType", "DealSecurityOwnershipRelationships", "DealSecurityOwnershipsDocument", "DealSecurityRelationships", "DealSecurityTitleIdentitiesDocument", "DealSecurityTitleIdentity", "DealSecurityTitleIdentityAttributes", "DealSecurityTitleIdentityDocument", "DealSecurityTitleIdentityEntityType", "DealSecurityTitleIdentityRelationships" ], "removed": [], "changed": [ "ContactGroupAttributes", "DealRelationships", "IncludedResource" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/ApiLoanSecurity", "after": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "loanSecurityInfo": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurity" }, "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactAccessType", "after": { "enum": [ "Other", "LoanParty" ], "type": "string", "x-ms-enum": { "name": "ContactAccessType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/reviewMonth", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "added", "path": "/components/schemas/DealRelationships/properties/loanSecurities", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/components/schemas/DealSecuritiesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurity" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecuritiesEntityType", "after": { "enum": [ "deal-securities" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/DealSecurity", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealSecurityAttributes", "after": { "type": "object", "properties": { "contactForAccess": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ContactAccessType" } ], "readOnly": true }, "isPreApproval": { "type": "boolean", "nullable": true }, "contractPrice": { "type": "number", "format": "double", "nullable": true }, "landValue": { "type": "number", "format": "double", "nullable": true }, "currentValue": { "type": "number", "format": "double", "nullable": true }, "contractDate": { "type": "string", "format": "date", "nullable": true }, "licensedRealEstateAgentContract": { "type": "boolean", "nullable": true }, "propertyState": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "isElectronicTransfer": { "type": "boolean", "nullable": true, "readOnly": true }, "titleType": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "valuationBasis": { "type": "string", "nullable": true, "readOnly": true }, "propertyType": { "type": "string", "nullable": true, "readOnly": true }, "propertyZoning": { "type": "string", "nullable": true, "readOnly": true }, "propertyHolding": { "type": "string", "nullable": true, "readOnly": true }, "propertyPrimaryPurpose": { "type": "string", "nullable": true, "readOnly": true }, "futureValue": { "type": "number", "format": "double", "nullable": true }, "buildAmount": { "type": "number", "format": "double", "nullable": true }, "propertyStatus": { "type": "string", "nullable": true, "readOnly": true }, "constructionType": { "type": "string", "nullable": true, "readOnly": true }, "constructionCategory": { "type": "string", "nullable": true, "readOnly": true }, "propertyTransaction": { "type": "string", "nullable": true, "readOnly": true }, "securityType": { "type": "string", "nullable": true, "readOnly": true }, "propertySuburb": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "accessFaxNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessFaxAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessMobileNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessMobileAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessPhoneNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessPhoneAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessContactLastName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "isAnnualPropertyTax": { "type": "boolean", "nullable": true, "readOnly": true }, "accessContactFirstName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessContactTitle": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurity" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnership", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecurityOwnershipEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityOwnershipAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityOwnershipRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipAttributes", "after": { "type": "object", "properties": { "ownershipPercentage": { "type": "number", "format": "double", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityOwnership" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipEntityType", "after": { "enum": [ "deal-security-ownership" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipRelationships", "after": { "type": "object", "properties": { "business": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "contact": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipsDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurityOwnership" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityRelationships", "after": { "type": "object", "properties": { "titleIdentifications": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "address": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "asset": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentitiesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurityTitleIdentity" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentity", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecurityTitleIdentityEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityTitleIdentityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityTitleIdentityRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityAttributes", "after": { "type": "object", "properties": { "titleIdentificationType": { "type": "string", "nullable": true, "readOnly": true }, "value": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityTitleIdentity" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityEntityType", "after": { "enum": [ "deal-security-title-identity" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/deal-securities", "after": "#/components/schemas/DealSecurity" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/deal-security-ownership", "after": "#/components/schemas/DealSecurityOwnership" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/deal-security-title-identity", "after": "#/components/schemas/DealSecurityTitleIdentity" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a collection of securities for deals", "operationId": "DealSecurities_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecuritiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurities_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a single securities for a deal by id", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurity_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurity_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1asset", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets assets via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1ownership", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets ownerships via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityOwnershipsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1relationships~1asset", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a assets related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1relationships~1ownership", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a ownerships related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1relationships~1titleIdentifications", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a titleIdentifications related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1titleIdentifications", "after": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets titleIdentifications via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityTitleIdentitiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1loanSecurities", "after": { "get": { "tags": [ "Deals" ], "summary": "Gets loanSecurities via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecuritiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1loanSecurities", "after": { "get": { "tags": [ "Deals" ], "summary": "Gets a loanSecurities related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "5ddb5d8ebcdb5893797c2a047d63044071992c9a", "committedAt": "2025-02-05T09:58:30+10:00", "date": "2025-02-05", "title": "Address field length limits", "highlights": [ "Address responses specify a maximum of 500 characters for country, formatted address, postcode, street address and suburb, and 100 for state." ], "compatibility": "Check local storage lengths and generated model validation against these limits.", "swaggerSha256": "4abfc426f69296b44a791413036cf1977c19e4ddd3194c3cb732a102abb3fe2a", "counts": { "operations": 326, "paths": 163, "schemas": 368 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "Address" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/Address/properties/country", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Address/properties/formattedAddress", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Address/properties/postCode", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Address/properties/state", "after": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Address/properties/streetAddress", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/Address/properties/suburb", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } ] }, { "commit": "8c3a2b042cd93914df25a56246891ee036c08b4b", "committedAt": "2025-02-13T16:49:38+10:00", "date": "2025-02-13", "title": "Marital status and liability sub-types", "highlights": [ "Contact, lead and lead-contact attributes gain `maritalStatus`; income attributes gain read-only `incomeVerification`.", "Liabilities gain sub-type details and structured lead liabilities gain `liabilitySubTypeId`.", "Adds four GET and HEAD operations for liability sub-types related to a liability type." ], "swaggerSha256": "d3c0d1b2e6aea0d14b358574cd510098c80ac28e1aaf70d5e8f32bd1c090ee5c", "counts": { "operations": 330, "paths": 165, "schemas": 375 }, "operations": { "added": [ "GET /jsonapi/liability-types/{id}/liabilitySubTypes", "GET /jsonapi/liability-types/{id}/relationships/liabilitySubTypes", "HEAD /jsonapi/liability-types/{id}/liabilitySubTypes", "HEAD /jsonapi/liability-types/{id}/relationships/liabilitySubTypes" ], "removed": [], "changed": [] }, "schemas": { "added": [ "LiabilitySubType", "LiabilitySubTypeAttributes", "LiabilitySubTypeDocument", "LiabilitySubTypeRelationships", "LiabilitySubTypesDocument", "LiabilitySubTypesEntityType", "MaritalStatus" ], "removed": [], "changed": [ "ContactAttributes", "IncludedResource", "IncomeAttributes", "LeadAttributes", "LeadContact", "LeadLiability", "LiabilityAttributes", "LiabilityTypeRelationships" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/ContactAttributes/properties/maritalStatus", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MaritalStatus" } ] } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/liability-sub-types", "after": "#/components/schemas/LiabilitySubType" }, { "kind": "added", "path": "/components/schemas/IncomeAttributes/properties/incomeVerification", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/maritalStatus", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MaritalStatus" } ], "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadContact/properties/maritalStatus", "after": { "$ref": "#/components/schemas/MaritalStatus" } }, { "kind": "added", "path": "/components/schemas/LeadLiability/properties/liabilitySubTypeId", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "added", "path": "/components/schemas/LiabilityAttributes/properties/liabilitySubType", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/LiabilityAttributes/properties/liabilitySubTypeId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/LiabilitySubType", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitySubTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilitySubTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilitySubTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypeAttributes", "after": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypeDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilitySubType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypeRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": {}, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": {}, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilitySubType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypesEntityType", "after": { "enum": [ "liability-sub-types" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/LiabilityTypeRelationships/properties/liabilitySubTypes", "after": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/MaritalStatus", "after": { "enum": [ "Single", "Married", "DeFacto", "Separated", "Divorced", "Widowed" ], "type": "string", "x-ms-enum": { "name": "MaritalStatus", "modelAsString": true } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilitySubTypes", "after": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets liabilitySubTypes via a single related liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelated_Get_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilitySubTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelated_Head_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilitySubTypes", "after": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets a liabilitySubTypes related to a single liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelationship_Get_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelationship_Get_Head_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "commit": "b850785edd9f125ebf784f44140af74a77ad312d", "committedAt": "2025-02-21T10:43:42+10:00", "date": "2025-02-21", "title": "Contact group enquiry source details", "highlights": [ "Contact groups expose enquiry-source category, source and referrer identifiers, plus referrer and referrer-organisation names.", "Adds an enquiry-source system URL. These new response fields are read-only; names allow 200 characters and the URL allows 400." ], "swaggerSha256": "2da3ec307ed069672d519bc128a7ac927660f98b7a6d24b5330858ec90ea54e8", "counts": { "operations": 330, "paths": 165, "schemas": 375 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [], "removed": [], "changed": [ "ContactGroupAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceCategoryId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceId", "after": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceReferrerId", "after": { "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceReferrerName", "after": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceReferrerOrganisationName", "after": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceSystemUrl", "after": { "maxLength": 400, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } ] }, { "commit": "04860e67ab7fac27b2f7598c8a5c8cda469e4479", "committedAt": "2026-06-17T16:48:32+10:00", "date": "2026-06-17", "title": "Lenders mortgage insurance details on splits", "highlights": [ "Split attributes gain `amountInclLmi`, `capitaliseLmi` and `lmiPremium` to describe lenders mortgage insurance amounts and treatment.", "Shared metadata schemas allow nullable additional values. Supporting geometry and single-or-many document schemas are refreshed." ], "compatibility": "Review generated shared model names and nullable metadata handling. The operation list is unchanged.", "swaggerSha256": "250afc1370bd63a251ee0b35c5da715959e9e6d3aaca53444eaa2e229a4769c0", "counts": { "operations": 330, "paths": 165, "schemas": 377 }, "operations": { "added": [], "removed": [], "changed": [] }, "schemas": { "added": [ "ElevationModel", "GeometryRelate", "SingleOrManyData" ], "removed": [ "SingleOrManyData`1" ], "changed": [ "AdviserAddressDocument", "AdviserAddressesDocument", "AdviserDetailDocument", "AdviserDetailsDocument", "AdviserDocument", "AdvisersDocument", "AgreementHolderDocument", "AgreementHoldersDocument", "AssetCategoriesDocument", "AssetCategoryDocument", "AssetDocument", "AssetSubTypeDocument", "AssetSubTypesDocument", "AssetTypeDocument", "AssetTypesDocument", "AssetsDocument", "BusinessDocument", "BusinessesDocument", "ContactAddressDocument", "ContactAddressesDocument", "ContactDocument", "ContactExternalReferenceDocument", "ContactExternalReferencesDocument", "ContactGroupDocument", "ContactGroupsDocument", "ContactMarketingDocument", "ContactMarketingsDocument", "ContactsDocument", "DealDocument", "DealExternalReferenceDocument", "DealExternalReferencesDocument", "DealImportantDateDocument", "DealImportantDatesDocument", "DealNoteDocument", "DealNotesDocument", "DealParticipantDocument", "DealParticipantsDocument", "DealScenarioDocument", "DealScenariosDocument", "DealSecuritiesDocument", "DealSecurityDocument", "DealSecurityOwnershipDocument", "DealSecurityOwnershipsDocument", "DealSecurityTitleIdentitiesDocument", "DealSecurityTitleIdentityDocument", "DealStructureDocument", "DealStructureImportantDateDocument", "DealStructureImportantDatesDocument", "DealStructuresDocument", "DealsDocument", "EnquirySourceDocument", "EnquirySourcesDocument", "ErrorObject", "ExpenseCategoriesDocument", "ExpenseCategoryDocument", "ExpenseDocument", "ExpenseTypeDocument", "ExpenseTypesDocument", "ExpensesDocument", "FinancialAddressDocument", "FinancialAddressesDocument", "FinancialDocument", "FinancialsDocument", "GeometryFactory", "HighLevelSummariesDocument", "HighLevelSummaryDocument", "IncomeCategoriesDocument", "IncomeCategoryDocument", "IncomeDocument", "IncomeTypeDocument", "IncomeTypesDocument", "IncomesDocument", "IntegrationDocument", "IntegrationsDocument", "LeadDocument", "LeadsDocument", "LiabilitiesDocument", "LiabilityCategoriesDocument", "LiabilityCategoryDocument", "LiabilityDocument", "LiabilitySubTypeDocument", "LiabilitySubTypesDocument", "LiabilityTypeDocument", "LiabilityTypesDocument", "NtsGeometryServices", "OrganisationAddressDocument", "OrganisationAddressesDocument", "OrganisationDocument", "OrganisationsDocument", "OwnerDocument", "OwnersDocument", "PropertyTypeDocument", "PropertyTypesDocument", "ReferrerDocument", "ReferrerMemberDocument", "ReferrerMembersDocument", "ReferrerOrganisationDocument", "ReferrerOrganisationsDocument", "ReferrersDocument", "RelationshipObject", "RelationshipsMultipleDocument", "RelationshipsSingleDocument", "ResourceObjectDocument", "ResourceObjectsDocument", "Split", "StructuredLeadDocument", "StructuredLeadsDocument" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AdviserAddressDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserAddressDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserAddressesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserAddressesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDetailDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDetailDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDetailsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDetailsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdviserDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdvisersDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AdvisersDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AgreementHolderDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AgreementHolderDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AgreementHoldersDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AgreementHoldersDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetCategoriesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetCategoriesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetCategoryDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetCategoryDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetSubTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetSubTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetSubTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetSubTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/AssetsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/BusinessDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/BusinessDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/BusinessesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/BusinessesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactAddressDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactAddressDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactAddressesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactAddressesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactExternalReferenceDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactExternalReferenceDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactExternalReferencesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactExternalReferencesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactGroupDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactGroupDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactGroupsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactGroupsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactMarketingDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactMarketingDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactMarketingsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactMarketingsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ContactsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealExternalReferenceDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealExternalReferenceDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealExternalReferencesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealExternalReferencesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealImportantDateDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealImportantDateDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealImportantDatesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealImportantDatesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealNoteDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealNoteDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealNotesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealNotesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealParticipantDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealParticipantDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealParticipantsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealParticipantsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealScenarioDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealScenarioDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealScenariosDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealScenariosDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecuritiesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecuritiesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityOwnershipsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentitiesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentitiesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealSecurityTitleIdentityDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDateDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDateDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDatesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructureImportantDatesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructuresDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealStructuresDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/DealsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ElevationModel", "after": { "type": "object", "properties": { "extent": { "$ref": "#/components/schemas/Envelope" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/EnquirySourceDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/EnquirySourceDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/EnquirySourcesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/EnquirySourcesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ErrorObject/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseCategoriesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseCategoriesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpenseTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpensesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ExpensesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialAddressDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialAddressDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialAddressesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialAddressesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/FinancialsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/GeometryFactory/properties/elevationModel", "after": { "$ref": "#/components/schemas/ElevationModel" } }, { "kind": "added", "path": "/components/schemas/GeometryRelate", "after": { "type": "object", "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/HighLevelSummariesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/HighLevelSummariesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/HighLevelSummaryDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/HighLevelSummaryDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeCategoriesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeCategoriesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeCategoryDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeCategoryDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomeTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IncomesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IntegrationDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IntegrationDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IntegrationsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/IntegrationsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LeadDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LeadDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LeadsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LeadsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitiesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitiesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityCategoriesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityCategoriesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilitySubTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/LiabilityTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/NtsGeometryServices/properties/defaultElevationModel", "after": { "$ref": "#/components/schemas/ElevationModel" } }, { "kind": "added", "path": "/components/schemas/NtsGeometryServices/properties/geometryRelate", "after": { "$ref": "#/components/schemas/GeometryRelate" } }, { "kind": "added", "path": "/components/schemas/OrganisationAddressDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationAddressDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationAddressesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationAddressesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OrganisationsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OwnerDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OwnerDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OwnersDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/OwnersDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/PropertyTypeDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/PropertyTypeDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/PropertyTypesDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/PropertyTypesDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerMemberDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerMemberDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerMembersDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerMembersDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrerOrganisationsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrersDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ReferrersDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "changed", "path": "/components/schemas/RelationshipObject/properties/data/$ref", "before": "#/components/schemas/SingleOrManyData`1", "after": "#/components/schemas/SingleOrManyData" }, { "kind": "added", "path": "/components/schemas/RelationshipObject/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/RelationshipsMultipleDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/RelationshipsSingleDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ResourceObjectDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ResourceObjectDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ResourceObjectsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/ResourceObjectsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/SingleOrManyData", "after": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/SingleOrManyData`1", "before": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/Split/properties/amountInclLmi", "after": { "type": "number", "format": "double", "nullable": true } }, { "kind": "added", "path": "/components/schemas/Split/properties/capitaliseLmi", "after": { "type": "boolean", "nullable": true } }, { "kind": "added", "path": "/components/schemas/Split/properties/lmiPremium", "after": { "type": "number", "format": "double", "nullable": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/StructuredLeadDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/StructuredLeadsDocument/properties/jsonApi/additionalProperties/nullable", "after": true }, { "kind": "added", "path": "/components/schemas/StructuredLeadsDocument/properties/meta/additionalProperties/nullable", "after": true }, { "kind": "changed", "path": "/openapi", "before": "3.0.1", "after": "3.0.4" } ] }, { "commit": "ac4a42b1ddc284fdf50102de33ad6b91f4fbc73f", "committedAt": "2026-09-25T09:40:20+10:00", "date": "2026-09-25", "title": "Tasks, contact categories and expanded writes", "highlights": [ "Adds task creation and update, individual task retrieval, and access to related assignees, contact groups and residential, asset-finance and commercial-finance deals.", "Adds contact category lookup, creation, update and deletion. Restores selected writes for contacts, contact groups, contact and deal external references, and integrations.", "Adds category inputs and category creation options to contact groups, leads and structured leads. Updates contact-group enquiry-source inputs, makes contact role writable, and increases business names to 500 characters.", "Corrects 22 to-one related-resource response schemas to single-resource documents and gives deal-note updates a dedicated patch document." ], "compatibility": "Removes the three write operations on a deal note’s deal relationship. Review request models and to-one response parsing when updating clients; new schemas alone do not imply a supported endpoint.", "overviewHighlights": [ "Create and update tasks, retrieve individual tasks, and follow their links to assignees, client groups and deals.", "Manage contact categories and use expanded write operations for contacts, contact groups, external references and integrations.", "Supply category and enquiry-source information, and use corrected response models for relationships that return a single resource." ], "swaggerSha256": "9b2ed01edb7b1745b4fac698e7d5be2035f17f5c93e6ddddbd1c58d199cb3684", "counts": { "operations": 371, "paths": 179, "schemas": 514 }, "operations": { "added": [ "DELETE /jsonapi/contact-categories/{id}", "DELETE /jsonapi/contact-external-references/{id}", "DELETE /jsonapi/contact-groups/{id}", "DELETE /jsonapi/contacts/{id}", "DELETE /jsonapi/deal-external-references/{id}", "DELETE /jsonapi/integrations/{id}", "GET /jsonapi/contact-categories", "GET /jsonapi/contact-categories/{id}", "GET /jsonapi/tasks/{id}", "GET /jsonapi/tasks/{id}/assetFinanceDiversifiedDeal", "GET /jsonapi/tasks/{id}/assignee", "GET /jsonapi/tasks/{id}/commercialFinanceDiversifiedDeal", "GET /jsonapi/tasks/{id}/contactGroups", "GET /jsonapi/tasks/{id}/relationships/assetFinanceDiversifiedDeal", "GET /jsonapi/tasks/{id}/relationships/assignee", "GET /jsonapi/tasks/{id}/relationships/commercialFinanceDiversifiedDeal", "GET /jsonapi/tasks/{id}/relationships/contactGroups", "GET /jsonapi/tasks/{id}/relationships/residentialDeal", "GET /jsonapi/tasks/{id}/residentialDeal", "HEAD /jsonapi/contact-categories", "HEAD /jsonapi/contact-categories/{id}", "HEAD /jsonapi/tasks/{id}/assetFinanceDiversifiedDeal", "HEAD /jsonapi/tasks/{id}/assignee", "HEAD /jsonapi/tasks/{id}/commercialFinanceDiversifiedDeal", "HEAD /jsonapi/tasks/{id}/contactGroups", "HEAD /jsonapi/tasks/{id}/relationships/assetFinanceDiversifiedDeal", "HEAD /jsonapi/tasks/{id}/relationships/assignee", "HEAD /jsonapi/tasks/{id}/relationships/commercialFinanceDiversifiedDeal", "HEAD /jsonapi/tasks/{id}/relationships/contactGroups", "HEAD /jsonapi/tasks/{id}/relationships/residentialDeal", "HEAD /jsonapi/tasks/{id}/residentialDeal", "PATCH /jsonapi/contact-categories/{id}", "PATCH /jsonapi/contact-external-references/{id}", "PATCH /jsonapi/contact-groups/{id}", "PATCH /jsonapi/contacts/{id}", "PATCH /jsonapi/deal-external-references/{id}", "PATCH /jsonapi/integrations/{id}", "PATCH /jsonapi/tasks/{id}", "POST /jsonapi/contact-categories", "POST /jsonapi/contact-external-references", "POST /jsonapi/contacts", "POST /jsonapi/deal-external-references", "POST /jsonapi/integrations", "POST /jsonapi/tasks" ], "removed": [ "DELETE /jsonapi/deal-notes/{id}/relationships/deal", "PATCH /jsonapi/deal-notes/{id}/relationships/deal", "POST /jsonapi/deal-notes/{id}/relationships/deal" ], "changed": [ "GET /jsonapi/adviser-details/{id}/adviser", "GET /jsonapi/adviser-details/{id}/relationships/adviser", "GET /jsonapi/advisers/{id}/adviserDetails", "GET /jsonapi/advisers/{id}/organisation", "GET /jsonapi/advisers/{id}/relationships/adviserDetails", "GET /jsonapi/advisers/{id}/relationships/organisation", "GET /jsonapi/contact-external-references/{id}/contact", "GET /jsonapi/contact-external-references/{id}/integration", "GET /jsonapi/contact-external-references/{id}/relationships/contact", "GET /jsonapi/contact-external-references/{id}/relationships/integration", "GET /jsonapi/contact-groups/{id}/adviser", "GET /jsonapi/contact-groups/{id}/referrer", "GET /jsonapi/contact-groups/{id}/referrerOrganisation", "GET /jsonapi/contact-groups/{id}/relationships/adviser", "GET /jsonapi/contact-groups/{id}/relationships/referrer", "GET /jsonapi/contact-groups/{id}/relationships/referrerOrganisation", "GET /jsonapi/contacts/{id}/contactGroup", "GET /jsonapi/contacts/{id}/relationships/contactGroup", "GET /jsonapi/deal-external-references/{id}/deal", "GET /jsonapi/deal-external-references/{id}/integration", "GET /jsonapi/deal-external-references/{id}/relationships/deal", "GET /jsonapi/deal-external-references/{id}/relationships/integration", "GET /jsonapi/deal-notes/{id}/deal", "GET /jsonapi/deal-notes/{id}/relationships/deal", "GET /jsonapi/deal-participants/{id}/contact", "GET /jsonapi/deal-participants/{id}/deal", "GET /jsonapi/deal-participants/{id}/relationships/contact", "GET /jsonapi/deal-participants/{id}/relationships/deal", "GET /jsonapi/deal-securities/{id}/asset", "GET /jsonapi/deal-securities/{id}/relationships/asset", "GET /jsonapi/deals/{id}/adviser", "GET /jsonapi/deals/{id}/dealScenario", "GET /jsonapi/deals/{id}/relationships/adviser", "GET /jsonapi/deals/{id}/relationships/dealScenario", "GET /jsonapi/expense-types/{id}/expenseCategory", "GET /jsonapi/expense-types/{id}/relationships/expenseCategory", "GET /jsonapi/income-types/{id}/incomeCategory", "GET /jsonapi/income-types/{id}/relationships/incomeCategory", "GET /jsonapi/incomes/{id}/linkedAsset", "GET /jsonapi/incomes/{id}/relationships/linkedAsset", "GET /jsonapi/liabilities/{id}/linkedAsset", "GET /jsonapi/liabilities/{id}/relationships/linkedAsset", "GET /jsonapi/liability-types/{id}/liabilityCategory", "GET /jsonapi/liability-types/{id}/relationships/liabilityCategory", "PATCH /jsonapi/deal-notes/{id}" ] }, "schemas": { "added": [ "AdviserCreate", "AdviserCreateDocument", "AdviserCreateRelationships", "AdviserDetailCreate", "AdviserDetailCreateDocument", "AdviserDetailCreateRelationships", "AdviserDetailPatch", "AdviserDetailPatchDocument", "AdviserDetailPatchRelationships", "AdviserPatch", "AdviserPatchDocument", "AdviserPatchRelationships", "AssetCreate", "AssetCreateDocument", "AssetCreateRelationships", "AssetDealEntityType", "AssetPatch", "AssetPatchDocument", "AssetPatchRelationships", "CommercialDealEntityType", "ContactCategoriesDocument", "ContactCategoriesEntityType", "ContactCategory", "ContactCategoryAttributes", "ContactCategoryDocument", "ContactCategoryRelationships", "ContactCreate", "ContactCreateDocument", "ContactCreateRelationships", "ContactExternalReferencePatch", "ContactExternalReferencePatchDocument", "ContactExternalReferencePatchRelationships", "ContactGroupCreate", "ContactGroupCreateDocument", "ContactGroupCreateRelationships", "ContactGroupPatch", "ContactGroupPatchDocument", "ContactGroupPatchRelationships", "ContactPatch", "ContactPatchDocument", "ContactPatchRelationships", "DealCreate", "DealCreateDocument", "DealCreateRelationships", "DealExternalReferencePatch", "DealExternalReferencePatchDocument", "DealExternalReferencePatchRelationships", "DealNotePatch", "DealNotePatchDocument", "DealNotePatchRelationships", "DealParticipantCreate", "DealParticipantCreateDocument", "DealParticipantCreateRelationships", "DealParticipantPatch", "DealParticipantPatchDocument", "DealParticipantPatchRelationships", "DealPatch", "DealPatchDocument", "DealPatchRelationships", "DealSecurityCreate", "DealSecurityCreateDocument", "DealSecurityCreateRelationships", "DealSecurityPatch", "DealSecurityPatchDocument", "DealSecurityPatchRelationships", "ExpenseCategoryCreate", "ExpenseCategoryCreateDocument", "ExpenseCategoryCreateRelationships", "ExpenseCategoryPatch", "ExpenseCategoryPatchDocument", "ExpenseCategoryPatchRelationships", "ExpenseCreate", "ExpenseCreateDocument", "ExpenseCreateRelationships", "ExpensePatch", "ExpensePatchDocument", "ExpensePatchRelationships", "ExpenseTypeCreate", "ExpenseTypeCreateDocument", "ExpenseTypeCreateRelationships", "ExpenseTypePatch", "ExpenseTypePatchDocument", "ExpenseTypePatchRelationships", "IncomeCategoryCreate", "IncomeCategoryCreateDocument", "IncomeCategoryCreateRelationships", "IncomeCategoryPatch", "IncomeCategoryPatchDocument", "IncomeCategoryPatchRelationships", "IncomeCreate", "IncomeCreateDocument", "IncomeCreateRelationships", "IncomePatch", "IncomePatchDocument", "IncomePatchRelationships", "IncomeTypeCreate", "IncomeTypeCreateDocument", "IncomeTypeCreateRelationships", "IncomeTypePatch", "IncomeTypePatchDocument", "IncomeTypePatchRelationships", "IntegrationCreate", "IntegrationCreateDocument", "IntegrationCreateRelationships", "IntegrationPatch", "IntegrationPatchDocument", "IntegrationPatchRelationships", "InteractiveTaskPriorityDto", "InteractiveTaskProgressDto", "LiabilityCategoryCreate", "LiabilityCategoryCreateDocument", "LiabilityCategoryCreateRelationships", "LiabilityCategoryPatch", "LiabilityCategoryPatchDocument", "LiabilityCategoryPatchRelationships", "LiabilityCreate", "LiabilityCreateDocument", "LiabilityCreateRelationships", "LiabilityPatch", "LiabilityPatchDocument", "LiabilityPatchRelationships", "LiabilityTypeCreate", "LiabilityTypeCreateDocument", "LiabilityTypeCreateRelationships", "LiabilityTypePatch", "LiabilityTypePatchDocument", "LiabilityTypePatchRelationships", "OrganisationCreate", "OrganisationCreateDocument", "OrganisationCreateRelationships", "OrganisationPatch", "OrganisationPatchDocument", "OrganisationPatchRelationships", "Task", "TaskAttributes", "TaskDocument", "TaskRelationships", "TasksDocument", "TasksEntityType" ], "removed": [ "RelationshipObject", "SingleOrManyData" ], "changed": [ "BusinessAttributes", "ContactAttributes", "ContactGroupAttributes", "ContactGroupRelationships", "IncludedResource", "LeadAttributes", "RelationshipsSingleDocument", "StructuredLeadAttributes" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AdviserCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdvisersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AdviserCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AdviserCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AdviserDetailCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserDetailsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserDetailAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserDetailCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AdviserDetailCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserDetailCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AdviserDetailCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AdviserDetailPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserDetailsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserDetailAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserDetailPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AdviserDetailPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserDetailPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AdviserDetailPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AdviserPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdvisersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AdviserPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AdviserPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AssetCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AssetCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/AssetDealEntityType", "after": { "enum": [ "asset-deal" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/AssetPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/AssetPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/AssetPatchRelationships", "after": { "type": "object" } }, { "kind": "changed", "path": "/components/schemas/BusinessAttributes/properties/name/maxLength", "before": 200, "after": 500 }, { "kind": "added", "path": "/components/schemas/CommercialDealEntityType", "after": { "enum": [ "commercial-deal" ], "type": "string" } }, { "kind": "removed", "path": "/components/schemas/ContactAttributes/properties/role/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/ContactCategoriesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactCategoriesEntityType", "after": { "enum": [ "contact-categories" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/ContactCategory", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactCategoryAttributes", "after": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "orderBy": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactCategoryDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactCategoryRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ContactCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactCreateRelationships", "after": { "type": "object", "properties": { "contactGroup": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, { "kind": "added", "path": "/components/schemas/ContactExternalReferencePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactExternalReferencePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactExternalReferencePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactExternalReferencePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactExternalReferencePatchRelationships", "after": { "type": "object" } }, { "kind": "removed", "path": "/components/schemas/ContactGroupAttributes/properties/categories/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/ContactGroupAttributes/properties/categoriesAllowCreate", "after": { "type": "boolean", "writeOnly": true } }, { "kind": "removed", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceCategoryId/readOnly", "before": true }, { "kind": "removed", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceId/readOnly", "before": true }, { "kind": "removed", "path": "/components/schemas/ContactGroupAttributes/properties/enquirySourceReferrerId/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/ContactGroupCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactGroupCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroupCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactGroupCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ContactGroupPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactGroupPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroupPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactGroupPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/$ref", "after": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/allOf", "before": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrer/writeOnly", "before": true }, { "kind": "added", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/$ref", "after": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/allOf", "before": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "removed", "path": "/components/schemas/ContactGroupRelationships/properties/referrerOrganisation/writeOnly", "before": true }, { "kind": "added", "path": "/components/schemas/ContactPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ContactPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ContactPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealAttributes" }, "relationships": { "$ref": "#/components/schemas/DealCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealExternalReferencePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/DealExternalReferencePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealExternalReferencePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealExternalReferencePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealExternalReferencePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealNotePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealNotesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealNoteAttributes" }, "relationships": { "$ref": "#/components/schemas/DealNotePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealNotePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealNotePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealNotePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealParticipantCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealParticipantsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealParticipantAttributes" }, "relationships": { "$ref": "#/components/schemas/DealParticipantCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealParticipantCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealParticipantCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealParticipantCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealParticipantPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealParticipantsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealParticipantAttributes" }, "relationships": { "$ref": "#/components/schemas/DealParticipantPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealParticipantPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealParticipantPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealParticipantPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealAttributes" }, "relationships": { "$ref": "#/components/schemas/DealPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealSecurityCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealSecurityCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealSecurityPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealSecurityPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealSecurityPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpenseCategoryPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpenseCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpensesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpenseCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpenseCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpensePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpensesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpensePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpensePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpensePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpensePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpenseTypeCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpenseTypeCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpenseTypeCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/ExpenseTypePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/ExpenseTypePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/ExpenseTypePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/contact-categories", "after": "#/components/schemas/ContactCategory" }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/tasks", "after": "#/components/schemas/Task" }, { "kind": "added", "path": "/components/schemas/IncomeCategoryCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomeCategoryCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomeCategoryCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncomeCategoryPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomeCategoryPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomeCategoryPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncomeCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomeCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomeCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncomePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncomeTypeCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomeTypeCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomeTypeCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IncomeTypePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IncomeTypePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IncomeTypePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IntegrationCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IntegrationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IntegrationAttributes" }, "relationships": { "$ref": "#/components/schemas/IntegrationCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IntegrationCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IntegrationCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IntegrationCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/IntegrationPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IntegrationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IntegrationAttributes" }, "relationships": { "$ref": "#/components/schemas/IntegrationPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/IntegrationPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IntegrationPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/IntegrationPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/InteractiveTaskPriorityDto", "after": { "enum": [ "Critical", "High", "Medium", "Normal" ], "type": "string", "x-ms-enum": { "name": "InteractiveTaskPriorityDto", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/InteractiveTaskProgressDto", "after": { "enum": [ "Completed", "InProgress", "NotRequired", "NotStarted", "OnHold" ], "type": "string", "x-ms-enum": { "name": "InteractiveTaskProgressDto", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/categories", "after": { "type": "array", "items": { "type": "string" }, "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LeadAttributes/properties/categoriesAllowCreate", "after": { "type": "boolean", "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityCategoryPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilityCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilityPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityPatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilityTypeCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityTypeCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityTypeCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/LiabilityTypePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/LiabilityTypePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/LiabilityTypePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/OrganisationCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/OrganisationCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/OrganisationCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/OrganisationCreateRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/OrganisationPatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/OrganisationPatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/OrganisationPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/OrganisationPatchRelationships", "after": { "type": "object" } }, { "kind": "removed", "path": "/components/schemas/RelationshipObject", "before": { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/RelationshipLinks" }, "data": { "$ref": "#/components/schemas/SingleOrManyData" }, "meta": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false } }, { "kind": "removed", "path": "/components/schemas/RelationshipsSingleDocument/properties/data/$ref", "before": "#/components/schemas/ResourceIdentifier" }, { "kind": "added", "path": "/components/schemas/RelationshipsSingleDocument/properties/data/allOf", "after": [ { "$ref": "#/components/schemas/ResourceIdentifier" } ] }, { "kind": "added", "path": "/components/schemas/RelationshipsSingleDocument/properties/data/nullable", "after": true }, { "kind": "removed", "path": "/components/schemas/SingleOrManyData", "before": { "type": "object", "properties": { "value": { "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/categories", "after": { "type": "array", "items": { "type": "string" }, "nullable": true, "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/StructuredLeadAttributes/properties/categoriesAllowCreate", "after": { "type": "boolean", "writeOnly": true } }, { "kind": "added", "path": "/components/schemas/Task", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/TasksEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/TaskAttributes" }, "relationships": { "$ref": "#/components/schemas/TaskRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/TaskAttributes", "after": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "progress": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/InteractiveTaskProgressDto" } ] }, "priority": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/InteractiveTaskPriorityDto" } ] }, "dueDate": { "type": "string", "format": "date-time", "nullable": true } } } }, { "kind": "added", "path": "/components/schemas/TaskDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Task" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/TaskRelationships", "after": { "type": "object", "properties": { "assignee": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "residentialDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "contactGroups": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "assetFinanceDiversifiedDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "commercialFinanceDiversifiedDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, { "kind": "added", "path": "/components/schemas/TasksDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/TasksEntityType", "after": { "enum": [ "tasks" ], "type": "string" } }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AdvisersDocument", "after": "#/components/schemas/AdviserDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1adviser/get/summary", "before": "Gets advisers via a single related adviser detail", "after": "Gets adviser via a single related adviser detail" }, { "kind": "changed", "path": "/paths/~1jsonapi~1adviser-details~1{id}~1relationships~1adviser/get/summary", "before": "Gets a advisers related to a single adviser detail", "after": "Gets a adviser related to a single adviser detail" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AdviserDetailsDocument", "after": "#/components/schemas/AdviserDetailDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1adviserDetails/get/summary", "before": "Gets adviserDetails via a single related adviser", "after": "Gets adviserDetail via a single related adviser" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/OrganisationsDocument", "after": "#/components/schemas/OrganisationDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1organisation/get/summary", "before": "Gets organisations via a single related adviser", "after": "Gets organisation via a single related adviser" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1adviserDetails/get/summary", "before": "Gets a adviserDetails related to a single adviser", "after": "Gets a adviserDetail related to a single adviser" }, { "kind": "changed", "path": "/paths/~1jsonapi~1advisers~1{id}~1relationships~1organisation/get/summary", "before": "Gets a organisations related to a single adviser", "after": "Gets a organisation related to a single adviser" }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-categories", "after": { "get": { "tags": [ "ContactCategories" ], "summary": "Gets a collection of contact categories", "operationId": "ContactCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "ContactCategories" ], "summary": "Creates a new contact category with attributes, relationships or both", "operationId": "ContactCategory_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-categories~1{id}", "after": { "get": { "tags": [ "ContactCategories" ], "summary": "Gets a single contact category by id", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "ContactCategories" ], "summary": "Updates the attributes and/or relationships of an existing contact category. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "ContactCategories" ], "summary": "Deletes an existing contact category", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-external-references/post", "after": { "tags": [ "ContactExternalReferences" ], "summary": "Creates a new contact external reference with attributes, relationships or both", "operationId": "ContactExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-external-references~1{id}/delete", "after": { "tags": [ "ContactExternalReferences" ], "summary": "Deletes an existing contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-external-references~1{id}/patch", "after": { "tags": [ "ContactExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing contact external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferencePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1contact/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ContactsDocument", "after": "#/components/schemas/ContactDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1contact/get/summary", "before": "Gets contacts via a single related contact external reference", "after": "Gets contact via a single related contact external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1integration/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/IntegrationsDocument", "after": "#/components/schemas/IntegrationDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1integration/get/summary", "before": "Gets integrations via a single related contact external reference", "after": "Gets integration via a single related contact external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1contact/get/summary", "before": "Gets a contacts related to a single contact external reference", "after": "Gets a contact related to a single contact external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-external-references~1{id}~1relationships~1integration/get/summary", "before": "Gets a integrations related to a single contact external reference", "after": "Gets a integration related to a single contact external reference" }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-groups~1{id}/delete", "after": { "tags": [ "ContactGroups" ], "summary": "Deletes an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contact-groups~1{id}/patch", "after": { "tags": [ "ContactGroups" ], "summary": "Updates the attributes and/or relationships of an existing contact group. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1adviser/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AdvisersDocument", "after": "#/components/schemas/AdviserDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1adviser/get/summary", "before": "Gets advisers via a single related contact group", "after": "Gets adviser via a single related contact group" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ReferrerMembersDocument", "after": "#/components/schemas/ReferrerMemberDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrer/get/summary", "before": "Gets referrers via a single related contact group", "after": "Gets referrer via a single related contact group" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrerOrganisation/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ReferrerOrganisationsDocument", "after": "#/components/schemas/ReferrerOrganisationDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1referrerOrganisation/get/summary", "before": "Gets referrerOrganisations via a single related contact group", "after": "Gets referrerOrganisation via a single related contact group" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1adviser/get/summary", "before": "Gets a advisers related to a single contact group", "after": "Gets a adviser related to a single contact group" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrer/get/summary", "before": "Gets a referrers related to a single contact group", "after": "Gets a referrer related to a single contact group" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contact-groups~1{id}~1relationships~1referrerOrganisation/get/summary", "before": "Gets a referrerOrganisations related to a single contact group", "after": "Gets a referrerOrganisation related to a single contact group" }, { "kind": "added", "path": "/paths/~1jsonapi~1contacts/post", "after": { "tags": [ "Contacts" ], "summary": "Creates a new contact with attributes, relationships or both", "operationId": "Contact_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contacts~1{id}/delete", "after": { "tags": [ "Contacts" ], "summary": "Deletes an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1contacts~1{id}/patch", "after": { "tags": [ "Contacts" ], "summary": "Updates the attributes and/or relationships of an existing contact. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1contactGroup/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ContactGroupsDocument", "after": "#/components/schemas/ContactGroupDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1contactGroup/get/summary", "before": "Gets contactGroups via a single related contact", "after": "Gets contactGroup via a single related contact" }, { "kind": "changed", "path": "/paths/~1jsonapi~1contacts~1{id}~1relationships~1contactGroup/get/summary", "before": "Gets a contactGroups related to a single contact", "after": "Gets a contactGroup related to a single contact" }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-external-references/post", "after": { "tags": [ "DealExternalReferences" ], "summary": "Creates a new deal external reference with attributes, relationships or both", "operationId": "DealExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-external-references~1{id}/delete", "after": { "tags": [ "DealExternalReferences" ], "summary": "Deletes an existing deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-external-references~1{id}/patch", "after": { "tags": [ "DealExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing deal external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferencePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1deal/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/DealsDocument", "after": "#/components/schemas/DealDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1deal/get/summary", "before": "Gets deals via a single related deal external reference", "after": "Gets deal via a single related deal external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1integration/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/IntegrationsDocument", "after": "#/components/schemas/IntegrationDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1integration/get/summary", "before": "Gets integrations via a single related deal external reference", "after": "Gets integration via a single related deal external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1deal/get/summary", "before": "Gets a deals related to a single deal external reference", "after": "Gets a deal related to a single deal external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-external-references~1{id}~1relationships~1integration/get/summary", "before": "Gets a integrations related to a single deal external reference", "after": "Gets a integration related to a single deal external reference" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}/patch/requestBody/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/DealNoteDocument", "after": "#/components/schemas/DealNotePatchDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1deal/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/DealsDocument", "after": "#/components/schemas/DealDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1deal/get/summary", "before": "Gets deals via a single related deal note", "after": "Gets deal via a single related deal note" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/delete", "before": { "tags": [ "DealNotes" ], "summary": "Removes a deal note from a to-many relationship with deals", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Delete_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/get/summary", "before": "Gets a deals related to a single deal note", "after": "Gets a deal related to a single deal note" }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/patch", "before": { "tags": [ "DealNotes" ], "summary": "Performs a complete replacement of a deal relationship on an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Patch_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "removed", "path": "/paths/~1jsonapi~1deal-notes~1{id}~1relationships~1deal/post", "before": { "tags": [ "DealNotes" ], "summary": "Adds deals to a to-many relationship with an existing deal note", "description": "Where `id` is the identifier of the primary deal note resource", "operationId": "DealNoteRelationship_Post_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ContactsDocument", "after": "#/components/schemas/ContactDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1contact/get/summary", "before": "Gets contacts via a single related participants in a deal", "after": "Gets contact via a single related participants in a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/DealsDocument", "after": "#/components/schemas/DealDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1deal/get/summary", "before": "Gets deals via a single related participants in a deal", "after": "Gets deal via a single related participants in a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1contact/get/summary", "before": "Gets a contacts related to a single participants in a deal", "after": "Gets a contact related to a single participants in a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-participants~1{id}~1relationships~1deal/get/summary", "before": "Gets a deals related to a single participants in a deal", "after": "Gets a deal related to a single participants in a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1asset/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AssetsDocument", "after": "#/components/schemas/AssetDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1asset/get/summary", "before": "Gets assets via a single related securities for a deal", "after": "Gets asset via a single related securities for a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deal-securities~1{id}~1relationships~1asset/get/summary", "before": "Gets a assets related to a single securities for a deal", "after": "Gets a asset related to a single securities for a deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AdvisersDocument", "after": "#/components/schemas/AdviserDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1adviser/get/summary", "before": "Gets advisers via a single related deal", "after": "Gets adviser via a single related deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/DealScenariosDocument", "after": "#/components/schemas/DealScenarioDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1dealScenario/get/summary", "before": "Gets dealScenarios via a single related deal", "after": "Gets dealScenario via a single related deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1adviser/get/summary", "before": "Gets a advisers related to a single deal", "after": "Gets a adviser related to a single deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1dealScenario/get/summary", "before": "Gets a dealScenarios related to a single deal", "after": "Gets a dealScenario related to a single deal" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/ExpenseCategoriesDocument", "after": "#/components/schemas/ExpenseCategoryDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}~1expenseCategory/get/summary", "before": "Gets expenseCategories via a single related expense type", "after": "Gets expenseCategory via a single related expense type" }, { "kind": "changed", "path": "/paths/~1jsonapi~1expense-types~1{id}~1relationships~1expenseCategory/get/summary", "before": "Gets a expenseCategories related to a single expense type", "after": "Gets a expenseCategory related to a single expense type" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/IncomeCategoriesDocument", "after": "#/components/schemas/IncomeCategoryDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}~1incomeCategory/get/summary", "before": "Gets incomeCategories via a single related income type", "after": "Gets incomeCategory via a single related income type" }, { "kind": "changed", "path": "/paths/~1jsonapi~1income-types~1{id}~1relationships~1incomeCategory/get/summary", "before": "Gets a incomeCategories related to a single income type", "after": "Gets a incomeCategory related to a single income type" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AssetsDocument", "after": "#/components/schemas/AssetDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1linkedAsset/get/summary", "before": "Gets linkedAssets via a single related income", "after": "Gets linkedAsset via a single related income" }, { "kind": "changed", "path": "/paths/~1jsonapi~1incomes~1{id}~1relationships~1linkedAsset/get/summary", "before": "Gets a linkedAssets related to a single income", "after": "Gets a linkedAsset related to a single income" }, { "kind": "added", "path": "/paths/~1jsonapi~1integrations/post", "after": { "tags": [ "Integrations" ], "summary": "Creates a new integration with attributes, relationships or both", "operationId": "Integration_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1integrations~1{id}/delete", "after": { "tags": [ "Integrations" ], "summary": "Deletes an existing integration", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1integrations~1{id}/patch", "after": { "tags": [ "Integrations" ], "summary": "Updates the attributes and/or relationships of an existing integration. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/AssetsDocument", "after": "#/components/schemas/AssetDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1linkedAsset/get/summary", "before": "Gets linkedAssets via a single related liabilities", "after": "Gets linkedAsset via a single related liabilities" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liabilities~1{id}~1relationships~1linkedAsset/get/summary", "before": "Gets a linkedAssets related to a single liabilities", "after": "Gets a linkedAsset related to a single liabilities" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory/get/responses/200/content/application~1vnd.api+json/schema/$ref", "before": "#/components/schemas/LiabilityCategoriesDocument", "after": "#/components/schemas/LiabilityCategoryDocument" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}~1liabilityCategory/get/summary", "before": "Gets liabilityCategories via a single related liability type", "after": "Gets liabilityCategory via a single related liability type" }, { "kind": "changed", "path": "/paths/~1jsonapi~1liability-types~1{id}~1relationships~1liabilityCategory/get/summary", "before": "Gets a liabilityCategories related to a single liability type", "after": "Gets a liabilityCategory related to a single liability type" }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks", "after": { "post": { "tags": [ "Tasks" ], "summary": "Creates a new task", "operationId": "Task_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a single task by id", "description": "Where `id` is the identifier of the task", "operationId": "Task_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "Tasks" ], "summary": "Updates the attributes and/or relationships of an existing task", "description": "Where `id` is the identifier of the task. Only the values of sent attributes/relationships are replaced.", "operationId": "Task_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1assetFinanceDiversifiedDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets assetFinanceDiversifiedDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1assignee", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets assignee via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1commercialFinanceDiversifiedDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets commercialFinanceDiversifiedDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CommercialDealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1contactGroups", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets contactGroups via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1relationships~1assetFinanceDiversifiedDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a assetFinanceDiversifiedDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1relationships~1assignee", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a assignee related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1relationships~1commercialFinanceDiversifiedDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a commercialFinanceDiversifiedDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1relationships~1contactGroups", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a contactGroups related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1relationships~1residentialDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets a residentialDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1tasks~1{id}~1residentialDeal", "after": { "get": { "tags": [ "Tasks" ], "summary": "Gets residentialDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] }, { "date": "2026-09-30", "title": "Custom deal statuses and deal structure updates", "highlights": [ "Read custom deal statuses and their sort order, including the statuses available to an organisation and the current custom status of a deal.", "Update a deal’s name and Australian or New Zealand rationale fields, and change its custom pipeline status using the new status-change operation.", "Create and update deal structures, retrieve an individual structure, and follow its links to the deal and important dates.", "Adds writable loan-structure details, including amounts, interest rates, loan terms, repayment frequency, fixed-rate dates and lenders mortgage insurance settings." ], "compatibility": "No operations are removed or existing operation definitions changed. Deal names now have a maximum length of 200 characters. The status-change operation uses `application/json` with `customStatusId` and requires a status belonging to the same organisation as the deal. Review the expanded shared schemas when regenerating clients.", "overviewHighlights": [ "Read your organisation’s custom pipeline statuses and change the custom status of a deal.", "Update deal names and rationale fields to keep information aligned with your integration.", "Create and update deal structures, including loan amounts, rates, repayments and lenders mortgage insurance details." ], "sourceKind": "specification-update", "swaggerSha256": "530ee79b382742b477450021a7866760495619fed4d9b37f1031d43db2408fef", "counts": { "operations": 397, "paths": 192, "schemas": 531 }, "operations": { "added": [ "GET /jsonapi/custom-statuses", "GET /jsonapi/custom-statuses/{id}", "GET /jsonapi/deal-structures/{id}", "GET /jsonapi/deal-structures/{id}/deal", "GET /jsonapi/deal-structures/{id}/dealImportantDates", "GET /jsonapi/deal-structures/{id}/relationships/deal", "GET /jsonapi/deal-structures/{id}/relationships/dealImportantDates", "GET /jsonapi/deals/{id}/customStatus", "GET /jsonapi/deals/{id}/relationships/customStatus", "GET /jsonapi/organisations/{id}/customStatuses", "GET /jsonapi/organisations/{id}/relationships/customStatuses", "HEAD /jsonapi/custom-statuses", "HEAD /jsonapi/custom-statuses/{id}", "HEAD /jsonapi/deal-structures/{id}", "HEAD /jsonapi/deal-structures/{id}/deal", "HEAD /jsonapi/deal-structures/{id}/dealImportantDates", "HEAD /jsonapi/deal-structures/{id}/relationships/deal", "HEAD /jsonapi/deal-structures/{id}/relationships/dealImportantDates", "HEAD /jsonapi/deals/{id}/customStatus", "HEAD /jsonapi/deals/{id}/relationships/customStatus", "HEAD /jsonapi/organisations/{id}/customStatuses", "HEAD /jsonapi/organisations/{id}/relationships/customStatuses", "PATCH /jsonapi/deal-structures/{id}", "PATCH /jsonapi/deals/{id}", "POST /jsonapi/deal-structures", "PUT /jsonapi/deals/{id}/status" ], "removed": [], "changed": [] }, "schemas": { "added": [ "AuDealRationale", "CustomStatus", "CustomStatusAttributes", "CustomStatusDocument", "CustomStatusRelationships", "CustomStatusesDocument", "CustomStatusesEntityType", "DealStatusChangeRequest", "DealStatusChangeResponse", "DealStructureCreate", "DealStructureCreateDocument", "DealStructureCreateRelationships", "DealStructurePatch", "DealStructurePatchDocument", "DealStructurePatchRelationships", "FrequencyType", "NzDealRationale" ], "removed": [], "changed": [ "DealAttributes", "DealRelationships", "DealStructureAttributes", "DealStructureRelationships", "IncludedResource", "OrganisationRelationships" ] }, "changes": [ { "kind": "added", "path": "/components/schemas/AuDealRationale", "after": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/CustomStatus", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/CustomStatusesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/CustomStatusAttributes" }, "relationships": { "$ref": "#/components/schemas/CustomStatusRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/CustomStatusAttributes", "after": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 0, "type": "string", "readOnly": true }, "sortOrder": { "type": "integer", "format": "int32", "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/CustomStatusDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/CustomStatus" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/CustomStatusRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/CustomStatusesDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomStatus" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/CustomStatusesEntityType", "after": { "enum": [ "custom-statuses" ], "type": "string" } }, { "kind": "added", "path": "/components/schemas/DealAttributes/properties/auRationale", "after": { "$ref": "#/components/schemas/AuDealRationale" } }, { "kind": "added", "path": "/components/schemas/DealAttributes/properties/name/maxLength", "after": 200 }, { "kind": "added", "path": "/components/schemas/DealAttributes/properties/name/minLength", "after": 0 }, { "kind": "removed", "path": "/components/schemas/DealAttributes/properties/name/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealAttributes/properties/nzRationale", "after": { "$ref": "#/components/schemas/NzDealRationale" } }, { "kind": "added", "path": "/components/schemas/DealRelationships/properties/customStatus", "after": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } }, { "kind": "added", "path": "/components/schemas/DealStatusChangeRequest", "after": { "required": [ "customStatusId" ], "type": "object", "properties": { "customStatusId": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealStatusChangeResponse", "after": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customStatusId": { "type": "integer", "format": "int32" }, "statusName": { "type": "string", "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/accountNumber", "after": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/amount/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/capitaliseLmi", "after": { "type": "boolean", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/fixedRateBeginDate/readOnly", "before": true }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/fixedRateExpiryDate/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/interestOnlyTermYears", "after": { "type": "number", "format": "double", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/interestRate/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/isLinkRateExpiry", "after": { "type": "boolean", "nullable": true } }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/lmiPremium", "after": { "type": "number", "format": "double", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/loanTermYears/readOnly", "before": true }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/paymentAmount/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/rateTermYears", "after": { "type": "integer", "format": "int32", "nullable": true } }, { "kind": "removed", "path": "/components/schemas/DealStructureAttributes/properties/rateType/readOnly", "before": true }, { "kind": "added", "path": "/components/schemas/DealStructureAttributes/properties/repaymentFrequency", "after": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/FrequencyType" } ] } }, { "kind": "added", "path": "/components/schemas/DealStructureCreate", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructuresEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructureCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealStructureCreateDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructureCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealStructureCreateRelationships", "after": { "type": "object", "properties": { "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, { "kind": "added", "path": "/components/schemas/DealStructurePatch", "after": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructuresEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructurePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/DealStructurePatchDocument", "after": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructurePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } } }, { "kind": "added", "path": "/components/schemas/DealStructurePatchRelationships", "after": { "type": "object" } }, { "kind": "added", "path": "/components/schemas/DealStructureRelationships/properties/deal/$ref", "after": "#/components/schemas/RelationshipsSingleDocument" }, { "kind": "removed", "path": "/components/schemas/DealStructureRelationships/properties/deal/allOf", "before": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ] }, { "kind": "removed", "path": "/components/schemas/DealStructureRelationships/properties/deal/writeOnly", "before": true }, { "kind": "added", "path": "/components/schemas/FrequencyType", "after": { "enum": [ "Yearly", "HalfYearly", "Quarterly", "Monthly", "Fortnightly", "Weekly", "HalfMonthly" ], "type": "string", "x-ms-enum": { "name": "FrequencyType", "modelAsString": true } } }, { "kind": "added", "path": "/components/schemas/IncludedResource/discriminator/mapping/custom-statuses", "after": "#/components/schemas/CustomStatus" }, { "kind": "added", "path": "/components/schemas/NzDealRationale", "after": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "lenderPreferences": { "type": "string", "nullable": true }, "loanStructure": { "type": "string", "nullable": true }, "productFeatures": { "type": "string", "nullable": true } }, "additionalProperties": false } }, { "kind": "added", "path": "/components/schemas/OrganisationRelationships/properties/customStatuses", "after": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } }, { "kind": "added", "path": "/paths/~1jsonapi~1custom-statuses", "after": { "get": { "tags": [ "CustomStatuses" ], "summary": "Gets a collection of custom statuses", "operationId": "CustomStatuses_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "CustomStatuses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "CustomStatuses_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1custom-statuses~1{id}", "after": { "get": { "tags": [ "CustomStatuses" ], "summary": "Gets a single custom status by id", "description": "Where `id` is the identifier of the custom status", "operationId": "CustomStatus_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "CustomStatuses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "CustomStatus_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures", "after": { "post": { "tags": [ "DealStructures" ], "summary": "Creates a new deal structure with attributes, relationships or both", "operationId": "DealStructure_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures~1{id}", "after": { "patch": { "tags": [ "DealStructures" ], "summary": "Updates the attributes and/or relationships of an existing deal structure. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructure_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructurePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "DealStructures" ], "summary": "Gets a single deal structure by id", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructure_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructure_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures~1{id}~1deal", "after": { "get": { "tags": [ "DealStructures" ], "summary": "Gets deal via a single related deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures~1{id}~1dealImportantDates", "after": { "get": { "tags": [ "DealStructures" ], "summary": "Gets dealImportantDates via a single related deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelated_Get_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureImportantDatesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelated_Head_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures~1{id}~1relationships~1deal", "after": { "get": { "tags": [ "DealStructures" ], "summary": "Gets a deal related to a single deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deal-structures~1{id}~1relationships~1dealImportantDates", "after": { "get": { "tags": [ "DealStructures" ], "summary": "Gets a dealImportantDates related to a single deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelationship_Get_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelationship_Get_Head_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}/patch", "after": { "tags": [ "Deals" ], "summary": "Updates the attributes and/or relationships of an existing deal. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal", "operationId": "Deal_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1customStatus", "after": { "get": { "tags": [ "Deals" ], "summary": "Gets customStatus via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1relationships~1customStatus", "after": { "get": { "tags": [ "Deals" ], "summary": "Gets a customStatus related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1deals~1{id}~1status", "after": { "put": { "tags": [ "Deals" ], "summary": "Changes the custom status of a deal", "description": "Where `id` is the identifier of the deal. The target `CustomStatusId` must belong to the same org as the deal.", "operationId": "DealStatus_ChangeStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealStatusChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealStatusChangeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1customStatuses", "after": { "get": { "tags": [ "Organisations" ], "summary": "Gets customStatuses via a single related organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelated_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelated_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, { "kind": "added", "path": "/paths/~1jsonapi~1organisations~1{id}~1relationships~1customStatuses", "after": { "get": { "tags": [ "Organisations" ], "summary": "Gets a customStatuses related to a single organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelationship_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelationship_Get_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } } ] } ] }