{ "openapi": "3.0.1", "info": { "title": "placement", "description": "This API collection provides the capability to manage aspects of the Placement structure. \nThis includes that overall management of Placements, Programmes, Contracts as well as any Sections within a Contract. This also includes the ability to set up carrier/underwriter participants for insurance placement purposes.", "version": "1" }, "servers": [ { "url": "https://sand-api.londonmarketgroup.co.uk/ppl/nextgen/placements", "description": "Joint Integration testing (JIT2) environment" } ], "tags": [ { "name": "health" }, { "name": "version" }, { "name": "placement", "description": "Enables the creation and management of the Placement structure that comprises of Programmes and Contracts." }, { "name": "programme", "description": "Enables the creation and management of Programme structures within a Placement. This also includes the capability to add existing Contracts into a programme." }, { "name": "contract", "description": "Enables the creation and management of Contract structured data." }, { "name": "section", "description": "Enables the creation and management of Contract sections, as structured data. Each Section represents of a specific partition of the overall risk to be insured. A section can be based upon the cover type, coverage (e.g. class of business), geographic territory and / or layer (limit of liability)." }, { "name": "participation", "description": "Enables the creation, management and processing of Open Market Underwriters and Facility Panel Underwriters that are willing to participate in the underwriting of an insured's asset or liability, represented within the un/structured information in a Contract or Section." }, { "name": "negotiation", "description": "Enables the creation and management of the flow of negotiations from a Broker to an Underwriter. Negotiations shown will be those which (1) have been formally communicated to the Underwriter; and (2) 'saved' Negotiation records (i.e. that are waiting to be sent to the Underwriter)." } ], "paths": { "/health": { "get": { "tags": [ "health" ], "description": "Checks the health of this Placement Resource API.", "operationId": "Health", "responses": { "200": { "description": "UP if ok.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/health" } } } } } } }, "/placements": { "get": { "tags": [ "placement" ], "description": "Returns a list of Placement records and any Programme structures, based upon various query parameters. This end point will also provide minimal information about any Contracts within the Placement structure. Pagination functionality is supported on this operation.", "operationId": "Placement_GetAll_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A list of system-generated unique identifiers for each Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$", "type": "array", "items": { "type": "string" } } }, { "name": "createdDate", "in": "query", "description": "The date timestamp when the entity was created.\nSearch using range method, e.g. createdDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "modifiedDate", "in": "query", "description": "The date timestamp when the entity was modified.\nSearch using range method, e.g. modifiedDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "brokerTeamId", "in": "query", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used. \nSearch using multiple exact match method, e.g. brokerTeamId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } }, { "name": "brokerTeamName", "in": "query", "description": "The name of the Broker Team, as defined by the broker organisation. \nSearch using contains method, e.g. brokerTeamName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "companyName", "in": "query", "description": "Name of the Company the User belongs to.\nSearch using contains method, e.g. companyName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "branchName", "in": "query", "description": "Name of the Branch the Broker Team belongs to.\nSearch using contains method, e.g. branchName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "brokerEmail", "in": "query", "description": "The User email of the Broker User responsible for the Placement.\nSearch using multiple exact match method, e.g. brokerEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "brokerFirstName", "in": "query", "description": "The First Name of the Broker User responsible for the Placement.\nSearch using contains method, e.g. brokerFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "brokerLastName", "in": "query", "description": "The Last Name of the Broker User responsible for the Placement.\nSearch using contains method, e.g. brokerLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "clientName", "in": "query", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance. \nSearch using contains method, e.g. clientName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,40}\\)$" } }, { "name": "placementDescription", "in": "query", "description": "A description of the Placement supplied by the Broker.\nSearch using contains method, e.g. placementDescription=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "effectiveYear", "in": "query", "description": "The represented year in which the Placement is effective for.\nSearch using multiple exact match method, e.g. effectiveYear=year1,year2,year3.", "schema": { "type": "string", "pattern": "^(\\d{4})(,\\d{4})*$" } }, { "name": "placementEarliestInceptionDate", "in": "query", "description": "The earliest inception date of all Contracts contained within the Placement structure.\nSearch using range method, e.g. placementEarliestInceptionDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}\\)$" } }, { "name": "placementStatus", "in": "query", "description": "The code that represents the overall Placement status.\nSearch using multiple exact match method, e.g. placementStatus=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "programmeDescription", "in": "query", "description": "A description of the Programme supplied by the Broker.\nSearch using contains method, e.g. programmeDescription=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "programmeEarliestInceptionDate", "in": "query", "description": "The earliest inception date of all Contracts contained within the Programme structure.\nSearch using range method, e.g. programmeEarliestInceptionDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}\\)$" } }, { "name": "programmeStatus", "in": "query", "description": "The code that represents the Programme status.\nSearch using multiple exact match method, e.g. programmeStatus=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "sort", "in": "query", "description": "Sorting field and order (unique field only).\nUse + before the field name for ascending order, use - for descending order.", "schema": { "type": "string", "pattern": "^[+-]?\\w+$" } }, { "name": "pageNumber", "in": "query", "description": "Number of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "example": 200 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_placements_getall" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "post": { "tags": [ "placement" ], "description": "Creates a Placement record. This is the starting point in order for Contracts and Programmes to be added into the platform.", "operationId": "Placement_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Placement structure for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_post" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "placement" } }, "/placements/{placementId}": { "get": { "tags": [ "placement" ], "description": "Returns the Placement structure for a specified Placement record. This will contains information about the Placement, its Programmes and summarised information about Contract records within the Placement structure.", "operationId": "Placement_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "placement" ], "description": "Updates a Placement record, where the record is in a state that enables its update.", "operationId": "Placement_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Placement structure for updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_put" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "placement" }, "delete": { "tags": [ "placement" ], "description": "Deletes a Placement record, where the record is in a state that enables its deletion.", "operationId": "Placement_Delete_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": {} }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/version": { "get": { "tags": [ "version" ], "description": "Checks the version of this Placement Resource API.", "operationId": "Version", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/version" } } } } } } }, "/placements/{placementId}/programmes": { "post": { "tags": [ "programme" ], "description": "Creates a Programme record under the Placement structure. This enables the grouping of Contract records that address a common insurance purpose. Contracts can be added at the time of creation.", "operationId": "Programme_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "A collection of Contracts for a common purpose. Programme structure for creation and updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/programme_post" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/programme_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "programme" } }, "/placements/{placementId}/programmes/{programmeId}": { "get": { "tags": [ "programme" ], "description": "Returns the Programme structure for a specified Programme record. This will return information about the Programme and summarised information about Contract records within the Programme structure.", "operationId": "Programme_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "programmeId", "in": "path", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/programme_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "programme" ], "description": "Updates a Programme record. Contracts can be added into the Programme structure.", "operationId": "Programme_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "programmeId", "in": "path", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "A collection of Contracts for a common purpose. Programme structure for creation and updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/programme_put" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/programme_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "programme" }, "delete": { "tags": [ "programme" ], "description": "Deletes a Programme record, where the record is in a state that enables its deletion. Any Contract records that exist in this Programme will be moved into the default Programme.", "operationId": "Programme_Delete_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "placementId", "in": "path", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "programmeId", "in": "path", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": {} }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/contracts": { "get": { "tags": [ "contract" ], "description": "Returns a list of Contract records, based upon various query parameters. Pagination functionality is supported on this operation.", "operationId": "Contract_GetAll_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A list of system-generated unique identifiers for each Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$", "type": "array", "items": { "type": "string" } } }, { "name": "clientName", "in": "query", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance. \nSearch using contains method, e.g. clientName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,40}\\)$" } }, { "name": "brokerEmail", "in": "query", "description": "The User email of the Broker User responsible for the Contract.\nSearch using multiple exact match method, e.g. brokerEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "brokerFirstName", "in": "query", "description": "The First Name of the Broker User responsible for the Contract.\nSearch using contains method, e.g. brokerFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "brokerLastName", "in": "query", "description": "The Last Name of the Broker User responsible for the Contract.\nSearch using contains method, e.g. brokerLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "description", "in": "query", "description": "A description of the Contract supplied by the Broker.\nSearch using contains method, e.g. description=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "uniqueMarketReference", "in": "query", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.\nSearch using multiple exact match method, e.g. uniqueMarketReference=umr1,umr2,umr3.", "schema": { "type": "string", "pattern": "^(B\\d{4}[A-Z0-9]{1,12})(,B\\d{4}[A-Z0-9]{1,12})*$" } }, { "name": "status", "in": "query", "description": "The code that represents the Contract status.\nSearch using multiple exact match method, e.g. status=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "inceptionDate", "in": "query", "description": "The date on which the (re)insurance contract/section comes into force.\nSearch using range method, e.g. inceptionDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}\\)$" } }, { "name": "createdDate", "in": "query", "description": "The date timestamp when the entity was created.\nSearch using range method, e.g. createdDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "modifiedDate", "in": "query", "description": "The date timestamp when the entity was modified.\nSearch using range method, e.g. modifiedDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "placementId", "in": "query", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.\nSearch using multiple exact match method, e.g. placementId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})(,[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})*$" } }, { "name": "companyName", "in": "query", "description": "Name of the Company the User belongs to.\nSearch using contains method, e.g. companyName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "brokerTeamId", "in": "query", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used. \nSearch using multiple exact match method, e.g. brokerTeamId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } }, { "name": "brokerTeamName", "in": "query", "description": "The name of the Broker Team, as defined by the broker organisation. \nSearch using contains method, e.g. brokerTeamName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "contractType", "in": "query", "description": "The code that represents the contract type.\nSearch using multiple exact match method, e.g. contractType=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "coverType", "in": "query", "description": "The code that represents the cover type.\nSearch using multiple exact match method, e.g. coverType=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "firstSignAndCloseDate", "in": "query", "description": "The date and timestamp of when a contract was first signed and closed.\nSearch using range method, e.g. firstSignAndCloseDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "productCode", "in": "query", "description": "The code that represents the insurance product under this Contract or Section.\nSearch using multiple exact match method, e.g. productCode=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "sort", "in": "query", "description": "Sorting field and order (unique field only).\nUse + before the field name for ascending order, use - for descending order.", "schema": { "type": "string", "pattern": "^[+-]?\\w+$" } }, { "name": "pageNumber", "in": "query", "description": "Number of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "example": 200 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_contracts_getall" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "post": { "tags": [ "contract" ], "description": "Creates a Contract record under the Placement structure. This will also create the "default" Section of information, which is necessary for adding Underwriters and Facility markets for underwriting purposes.", "operationId": "Contract_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Contract structure for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_post" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "contract" } }, "/contracts/{contractId}": { "get": { "tags": [ "contract" ], "description": "Returns a single Contract record. This record will contain core Contract information, that includes data attributes that summarise information about the risk to be insured, as well as a summarised list of any Contract Sections that exist within the Contract.", "operationId": "Contract_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "contract" ], "description": "Updates the Contract record. This will also update the "default" Section of information.", "operationId": "Contract_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Contract structure for updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_put" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "contract" }, "delete": { "tags": [ "contract" ], "description": "Deletes a Contract record, where the record is in a state that enables its deletion.", "operationId": "Contract_Delete_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": {} }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/contracts/{contractId}/sections": { "get": { "tags": [ "section" ], "description": "Returns a list of Section records, within a single Contract record. This returned list is a subset of all Section record fields, based upon various query parameters.", "operationId": "Section_GetAll_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A list of system-generated unique identifiers for each Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$", "type": "array", "items": { "type": "string" } } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "reference", "in": "query", "description": "A reference of the Section supplied by the Broker.\nSearch using contains method, e.g. reference=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\([a-zA-Z0-9 .,<>/\\\\@'#~;:\\[\\]{}!\"\"£$%^&()_+=]{1,12}\\)*$" } }, { "name": "description", "in": "query", "description": "A description of the Section supplied by the Broker.\nSearch using contains method, e.g. description=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "pageNumber", "in": "query", "description": "Number of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "example": 200 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_sections_getall" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "post": { "tags": [ "section" ], "description": "Creates a Section record under the Contract, representing a specific partition of the overall risk and / or coverage to be insured.", "operationId": "Section_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Section structure for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section_postput" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "section" } }, "/contracts/{contractId}/sections/{sectionId}": { "get": { "tags": [ "section" ], "description": "Returns a single Section record. This record will contain all the Section-related structured data.", "operationId": "Section_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "section" ], "description": "Updates a Section record, where the record is in a state that enables its update.", "operationId": "Section_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Section structure for updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section_postput" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "section" }, "delete": { "tags": [ "section" ], "description": "Deletes a Section record, where the record is in a state that enables its deletion.", "operationId": "Section_Delete_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": {} }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/contracts/{contractId}/sections/{sectionId}/participations": { "get": { "tags": [ "participation" ], "description": "Returns a list of Participation records, within a single Section. This returned list is based upon various query parameters. Pagination functionality is supported on this operation.", "operationId": "Participation_GetAll_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A list of system-generated unique identifiers for each Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$", "type": "array", "items": { "type": "string" } } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "createdDate", "in": "query", "description": "The date timestamp when the entity was created.\nSearch using range method, e.g. createdDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "modifiedDate", "in": "query", "description": "The date timestamp when the entity was modified.\nSearch using range method, e.g. modifiedDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "companyName", "in": "query", "description": "Name of the Company the User belongs to.\nSearch using contains method, e.g. companyName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "underwriterEmail", "in": "query", "description": "The email of the Underwriter. \nSearch using multiple exact match method, e.g. underwriterEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "underwriterFirstName", "in": "query", "description": "The first name by which the Underwriter is known for.\nSearch using contains method, e.g. underwriterFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "underwriterLastName", "in": "query", "description": "The last name by which the Underwriter is known for.\nSearch using contains method, e.g. underwriterLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "offPlatformUnderwriter", "in": "query", "description": "Indicates whether the Underwriter User is registered as an off-platform user (true) or not (false).\nSearch using single exact match method, e.g. offPlatformUnderwriter=true.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" }, "example": "true" }, { "name": "type", "in": "query", "description": "The code that represents the type of Participation.\nSearch using multiple exact match method, e.g. type=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "status", "in": "query", "description": "The code that represents the Participation status, based upon the Type of Participation.\nSearch using multiple exact match method, e.g. status=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "hasLineConditions", "in": "query", "description": "Parameter used to return Participation records that have at least one Line Conditions (true) or no Line Conditions (false), irrespective of the Status of the Line Condition.\nSearch using single exact match method, e.g. hasLineConditions=true.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" }, "example": "true" }, { "name": "hasSubjectivities", "in": "query", "description": "Parameter used to return Participation records that have at least one Subjectivity (true) or no Subjectivities (false), irrespective of the Status of the Subjectivity.\nSearch using single exact match method, e.g. hasSubjectivities=true.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" }, "example": "true" }, { "name": "isDeclaration", "in": "query", "description": "Parameter used to return Participation records that have been attached to this Section from a Master Facility arrangement.\nSearch using single exact match method, e.g. isDeclaration=true.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" }, "example": "true" }, { "name": "facilityPanelId", "in": "query", "description": "A system-generated unique identifier for a Facility Panel, with a format and structure defined by the technology used.\nSearch using multiple exact match method, e.g. facilityPanelId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } }, { "name": "sort", "in": "query", "description": "Sorting field and order (unique field only).\nUse + before the field name for ascending order, use - for descending order.", "schema": { "type": "string", "pattern": "^[+-]?\\w+$" } }, { "name": "pageNumber", "in": "query", "description": "Number of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "example": 200 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_participations_getall" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "post": { "tags": [ "participation" ], "description": "Creates Participation records representing either a single Open Market Underwriter and the Carrier Stamps they are permitted to use, or a multiple of Participation records representing each Underwriter from a panel of underwriters attaching from a Master Facility arrangement.", "operationId": "Participation_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Participation structure for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/participation_post" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_participations_getall_post" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "participation" } }, "/contracts/{contractId}/sections/{sectionId}/participations/{participationId}": { "get": { "tags": [ "participation" ], "description": "Returns a single Participation record. This record will contain the underwriter attributes for underwriting a risk, as well as any facility panel information, where the Underwriter's involvement is made through a Master Facility arrangement.", "operationId": "Participation_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "participationId", "in": "path", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/participation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "participation" ], "description": "Updates a Participation record, where the record is in a state that enables its update. Where an Underwriter update involves an update upon a Facility Panel, all involved Participations of said Facility Panel will be updated.", "operationId": "Participation_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "participationId", "in": "path", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Participation structure for updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/participation_put" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/participation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "participation" }, "delete": { "tags": [ "participation" ], "description": "Deletes a Participation record, where the record is in a state that enables its deletion.", "operationId": "Participation_Delete_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "sectionId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "participationId", "in": "path", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": {} }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/contracts/{contractId}/negotiations": { "get": { "tags": [ "negotiation" ], "description": "Returns a list of all Negotiation records based upon various query parameters. Pagination functionality is supported on this operation.", "operationId": "Negotiation_GetAll_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A list of system-generated unique identifiers for each Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$", "type": "array", "items": { "type": "string" } } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "showLatest", "in": "query", "description": "Identifies whether the query results will return only the latest Negotiation record (true) or all Negotiation records (false) for each Participation. Search using single exact match method, e.g. showLatest=true/false.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" } }, { "name": "createdDate", "in": "query", "description": "The date timestamp when the entity was created.\nSearch using range method, e.g. createdDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "modifiedDate", "in": "query", "description": "The date timestamp when the entity was modified.\nSearch using range method, e.g. modifiedDate=range(date1,date2).", "schema": { "type": "string", "pattern": "^range\\(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z,\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z\\)$" } }, { "name": "submissionId", "in": "query", "description": "A system-generated unique identifier for a Submission, with a format and structure defined by the technology used.\nSearch using multiple exact match method, e.g. submissionId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } }, { "name": "participationId", "in": "query", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.\nSearch using multiple exact match method, e.g. participationId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } }, { "name": "brokerTeamName", "in": "query", "description": "The name of the Broker Team, as defined by the broker organisation.\nSearch using contains method, e.g. brokerTeamName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "brokerEmail", "in": "query", "description": "The User email of the Broker User responsible for the Contract.\nSearch using multiple exact match method, e.g. brokerEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "brokerFirstName", "in": "query", "description": "The First Name of the Broker User responsible for the Contract.\nSearch using contains method, e.g. brokerFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "brokerLastName", "in": "query", "description": "The Last Name of the Broker User responsible for the Contract.\nSearch using contains method, e.g. brokerLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "underwriterTeamName", "in": "query", "description": "The name of the Underwriter Team, as defined by the Carrier organisation.\nSearch using contains method, e.g. underwriterTeamName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,256}\\)$" } }, { "name": "underwriterEmail", "in": "query", "description": "The email of the Underwriter. \nSearch using multiple exact match method, e.g. underwriterEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "underwriterFirstName", "in": "query", "description": "The first name by which the Underwriter is known for.\nSearch using contains method, e.g. underwriterFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "underwriterLastName", "in": "query", "description": "The last name by which the Underwriter is known for.\nSearch using contains method, e.g. underwriterLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "sentByEmail", "in": "query", "description": "The User email of the Broker or Underwriter User that sent this Negotiation.\nSearch using multiple exact match method, e.g. sentByEmail=email1,email2,email3.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+(,[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+)*$" } }, { "name": "sentByFirstName", "in": "query", "description": "The First Name of the Broker or Underwriter User that sent this Negotiation.\nSearch using contains method, e.g. sentByFirstName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "sentByLastName", "in": "query", "description": "The Last Name of the Broker or Underwriter User that sent this Negotiation.\nSearch using contains method, e.g. sentByLastName=contains(astring).", "schema": { "type": "string", "pattern": "^contains\\(.{1,30}\\)$" } }, { "name": "type", "in": "query", "description": "The type of the Negotiation.\nSearch using multiple exact match method, e.g. type=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "subType", "in": "query", "description": "The subtype of the Negotiation.\nSearch using multiple exact match method, e.g. subType=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "status", "in": "query", "description": "The code that represents the Negotiation status, based upon the Type of Negotiation.\nSearch using multiple exact match method, e.g. status=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "isLeader", "in": "query", "description": "Parameter used to return Negotiations records that have a leader role (true) or not (false).\nSearch using single exact match method, e.g. isLeader=true/false.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" } }, { "name": "role", "in": "query", "description": "The code that represents the role or roles that the Underwriter plays through their participation.\nSearch using multiple exact match method, e.g. role=code1,code2,code3.", "schema": { "type": "string", "pattern": "^(.*)(,.*)*$" } }, { "name": "hasLineConditions", "in": "query", "description": "Parameter used to return Negotiation records that have at least one Line Condition (true) or no Line Conditions (false) present in any Stamp within a Participation, irrespective of the Status of the Line Condition.\nSearch using single exact match method, e.g. hasLineConditions=true/false.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" } }, { "name": "hasSubjectivities", "in": "query", "description": "Parameter used to return Negotiation records that have at least one Subjectivity (true) or no Subjectivities (false) present.\nSearch using single exact match method, e.g. hasSubjectivities=true/false.", "schema": { "type": "string", "pattern": "^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$" } }, { "name": "sort", "in": "query", "description": "Sorting field and order (unique field only).\nUse + before the field name for ascending order, use - for descending order.", "schema": { "type": "string", "pattern": "^[+-]?\\w+$" } }, { "name": "pageNumber", "in": "query", "description": "Number of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Size of the page to be retrieved.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "example": 200 }, { "name": "sectionId", "in": "query", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.\nSearch using multiple exact match method, e.g. sectionId=id1,id2,id3.", "schema": { "type": "string", "pattern": "^(?:[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})(?:,[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12})*$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_placement_negotiations_getall" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "post": { "tags": [ "negotiation" ], "description": "Creates a single Negotiation record in response to an Underwriter User's response. Broker Users will be able to accept or reject, confirm or negotiate on various attributes of their involvement, i.e. acceptance of contractual roles, carrier stamps, line conditions and subjectivities.", "operationId": "Negotiation_Post_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Negotiation structure for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_post" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "negotiation" } }, "/contracts/{contractId}/negotiations/{negotiationId}": { "get": { "tags": [ "negotiation" ], "description": "Returns a single Negotiation record. This record will contain attributes pertaining to the single negotiation position between a Broker User and an Underwriter User, based upon its negotiation status within the insurance placement process.", "operationId": "Negotiation_GetById_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "negotiationId", "in": "path", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } }, "put": { "tags": [ "negotiation" ], "description": "Updates a Negotiation record, where the record is in a state that enables its update. For example, where Negotiations are in a saved and unsent state.", "operationId": "Negotiation_Put_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "negotiationId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Negotiation structure for updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_put" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "negotiation" } }, "/contracts/{contractId}/negotiations/{negotiationId}/send": { "post": { "tags": [ "negotiation" ], "description": "Initiates the operation to send the latest negotiation response back to an Underwriter. The outcome of this will either (1) agree to the change of terms; (2) negotiate the Underwriter's latest offer; or (3) withdraw the offer.", "operationId": "Negotiation_Send_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "X-Last-Modified", "in": "header", "description": "The date timestamp to be used to validate an update operation.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2014-12-31T23:59:59.938Z" }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "negotiationId", "in": "path", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "responses": { "200": { "description": "Negotiation output structure for send.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_negotiation_getbyid" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } } } }, "/contracts/{contractId}/assignRoles": { "post": { "tags": [ "contract" ], "description": "Initiates the asynchronous operation to assign the contractual roles to Participations and their Stamps on the Contract. Where a specific Slip Leader has been identified, the process will take this into consideration during the assignment process.", "operationId": "Contract_AssignRoles_v1", "parameters": [ { "name": "X-Auth-Impersonated-User", "in": "header", "description": "The email address of the Requesting User or the Impersonated User.", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, { "name": "X-Auth-Team", "in": "header", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used. For most operations, one and only one UUID is expected. Where collection-based operations are involved, comma-separated UUID values may be supplied.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, { "name": "contractId", "in": "path", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } } ], "requestBody": { "description": "Contract input structure for assign roles.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_assignroles" } } }, "required": false }, "responses": { "200": { "description": "Contract output structure for assign roles.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_assignroles_output" } } } }, "400": { "description": "Mandatory header parameter is missing from the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "401": { "description": "Authentication error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "404": { "description": "Invalid team or user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "414": { "description": "The maximum field length of the URI provided for the request has been exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_document" } } } } }, "x-codegen-request-body-name": "contract" } } }, "components": { "schemas": { "broker_team_org_company": { "required": [ "company_name", "organisation_name", "team_id", "team_name" ], "type": "object", "properties": { "team_id": { "type": "string", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "default": "" }, "team_name": { "type": "string", "description": "The name of the Broker Team, as defined by the broker organisation.", "default": "" }, "organisation_name": { "type": "string", "description": "Name of the Organisation the User belongs to.", "default": "" }, "company_name": { "type": "string", "description": "Name of the Company the User belongs to.", "default": "" } }, "additionalProperties": false, "description": "The team information of the Broker Team responsible for the node." }, "calculated": { "required": [ "line_percentage" ], "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 } }, "additionalProperties": false, "description": "The calculated signing down information, following the Broker invoking the signing down process in the Section." }, "facility_panel_get": { "required": [ "facility_id", "facility_panel_id", "proposed", "status" ], "type": "object", "properties": { "facility_panel_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel, with a format and structure defined by the technology used.", "default": "" }, "facility_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel set of Underwriters, with a format and structure defined by the technology used.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Facility Panel status, based upon the Type of Participation.", "default": "" }, "proposed": { "$ref": "#/components/schemas/proposed_panel" } }, "additionalProperties": false, "description": "The Facility Panel information, holding values from the Master Facility as a whole. This information will be consistent across all Participation records which originate from the same Master Facility." }, "facility_panel_post": { "required": [ "facility_id", "proposed" ], "type": "object", "properties": { "facility_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel set of Underwriters, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "import_facility_risk_codes": { "type": "boolean", "description": "Identifies where the facility risk classification will be used in this Section (true) or the current risk classification will be maintained (false).", "example": false }, "proposed": { "$ref": "#/components/schemas/proposed_panel" } }, "additionalProperties": false, "description": "The Facility Panel information, holding values from the Master Facility as a whole. This information will be consistent across all Participation records which originate from the same Master Facility." }, "facility_panel_put": { "required": [ "facility_id", "facility_panel_id", "proposed" ], "type": "object", "properties": { "facility_panel_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "facility_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel set of Underwriters, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "proposed": { "$ref": "#/components/schemas/proposed_panel" } }, "additionalProperties": false, "description": "The Facility Panel information, holding values from the Master Facility as a whole. This information will be consistent across all Participation records which originate from the same Master Facility." }, "facility_roles": { "required": [ "declaration_firm_order_role", "declaration_quote_role" ], "type": "object", "properties": { "declaration_quote_role": { "type": "string", "description": "The code that represents the quote role on the that the Underwriter participates in the Facility Panel, with their Participation.", "default": "" }, "declaration_firm_order_role": { "type": "string", "description": "The code that represents the firm order role on the that the Underwriter participates in the Facility Panel, with their Participation.", "default": "" } }, "additionalProperties": false, "description": "The facility role information that the Declaration Underwriter takes part in through their Participation." }, "line_condition_get": { "required": [ "code", "description", "line_condition_id", "status" ], "type": "object", "properties": { "line_condition_id": { "type": "string", "description": "A system-generated unique identifier for a Line Condition, with a format and structure defined by the technology used.", "default": "" }, "description": { "type": "string", "description": "A description of the line condition.", "default": "" }, "status": { "type": "string", "description": "The code that represents the status of the line condition when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "code": { "type": "string", "description": "The code that identifies whether a line condition is global line condition that functionally impacts platform behaviour.", "default": "" } }, "additionalProperties": false, "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement." }, "master_facility_get": { "required": [ "master_facility_id", "signed", "written" ], "type": "object", "properties": { "master_facility_id": { "type": "string", "description": "The unique identifier for a Master Facility, that this Participation record originates from.", "default": "" }, "written": { "$ref": "#/components/schemas/written_facility" }, "signed": { "$ref": "#/components/schemas/signed_facility" } }, "additionalProperties": false, "description": "The Master Facility information, holding original master facility information." }, "participation_getbyid": { "required": [ "broker_team", "broker_user", "contract_id", "metadata", "participation_id", "proposed", "section_id", "sequence_number", "status", "type", "underwriter_team", "underwriter_user", "written_line_basis" ], "type": "object", "properties": { "participation_id": { "type": "string", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number in which the Participation is ordered within a Section.", "format": "int32", "example": 0 }, "type": { "type": "string", "description": "The code that represents the type of Participation.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team_org_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "underwriter_team": { "$ref": "#/components/schemas/underwriter_team" }, "underwriter_user": { "$ref": "#/components/schemas/underwriter_user_participation" }, "sub_panel": { "$ref": "#/components/schemas/sub_panel_get" }, "status": { "type": "string", "description": "The code that represents the Participation status, based upon the Type of Participation.", "default": "" }, "status_reason": { "type": "string", "description": "The code that represents the reason for the Participation status", "default": "" }, "backload_code": { "type": "string", "description": "The code that represents the reason of the backload", "default": "" }, "backload_reason": { "type": "string", "description": "The textual description of the reason for the backload.", "default": "" }, "is_backload": { "type": "boolean", "description": "Indicates whether the Participation record has been loaded (true) into the platform through an archiving or backloading process, or not (false).", "example": false }, "written_line_basis": { "type": "string", "description": "The basis on which the underwriter's written lines are applied to the Order of a Contract or Section.", "default": "" }, "bound_date": { "type": "string", "description": "The date and timestamp when the Participation record is bound. This is set when (i) the Underwriter unconditionally accepts their participation; or (ii) when the broker accepts the Underwriter's conditional acceptance for their participation.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "proposed": { "$ref": "#/components/schemas/proposed" }, "written": { "$ref": "#/components/schemas/written" }, "calculated": { "$ref": "#/components/schemas/calculated" }, "signed": { "$ref": "#/components/schemas/signed" }, "roles": { "type": "array", "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead.", "items": { "$ref": "#/components/schemas/participation_role" } }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/stamp_get" } }, "subjectivities": { "type": "array", "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy.", "items": { "$ref": "#/components/schemas/subjectivity_get" } }, "facility_roles": { "$ref": "#/components/schemas/facility_roles" }, "declaration_underwriter": { "$ref": "#/components/schemas/team_user" }, "master_facility": { "$ref": "#/components/schemas/master_facility_get" }, "is_excluded_from_panel": { "type": "string", "description": "Identifies whether this Underwriter has been excluded (true) from participating on the Facility Panel for this Contract or Section, or not (false).", "example": "false" }, "facility_panel": { "$ref": "#/components/schemas/facility_panel_get" } }, "additionalProperties": false, "description": "Participation information" }, "participation_post": { "type": "object", "properties": { "underwriter_email": { "type": "string", "description": "The email address of the Underwriter.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "sub_panel": { "$ref": "#/components/schemas/sub_panel_postput" }, "proposed": { "$ref": "#/components/schemas/proposed" }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/stamp_postput" } }, "facility_panel": { "$ref": "#/components/schemas/facility_panel_post" } }, "additionalProperties": false, "description": "Participation structure for creates" }, "participation_put": { "type": "object", "properties": { "underwriter_email": { "type": "string", "description": "The email address of the Underwriter.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "sub_panel": { "$ref": "#/components/schemas/sub_panel_postput" }, "proposed": { "$ref": "#/components/schemas/proposed" }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/stamp_postput" } }, "facility_roles": { "$ref": "#/components/schemas/facility_roles" }, "is_excluded_from_panel": { "type": "boolean", "description": "Identifies whether this Underwriter has been excluded (true) from participating on the Facility Panel for this Contract or Section, or not (false).", "example": false }, "facility_panel": { "$ref": "#/components/schemas/facility_panel_put" } }, "additionalProperties": false, "description": "Participation structure for updates" }, "participation_role": { "required": [ "role", "status" ], "type": "object", "properties": { "role": { "type": "string", "description": "The code that represents the role or roles that the Underwriter plays through their participation.", "default": "" }, "status": { "type": "string", "description": "The code that represents the status of the role when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" } }, "additionalProperties": false, "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead." }, "proposed": { "type": "object", "properties": { "min_line_percentage": { "type": "number", "description": "The minimum underwriting value, as a percentage.", "example": 0.1 }, "max_line_percentage": { "type": "number", "description": "The maximum underwriting value, as a percentage.", "example": 0.1 }, "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "min_amount": { "type": "number", "description": "The minimum underwriting value, as an amount.", "example": 0.1 }, "max_amount": { "type": "number", "description": "The maximum underwriting value, as an amount.", "example": 0.1 }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The proposed underwriting line information, that the Broker is proposing to the Underwriter." }, "proposed_panel": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The proposed underwriting line information, that the Broker is proposing to the Underwriter for this facility." }, "reference_get": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "description": "The reference allocated by the underwriter against the Stamp.", "default": "" }, "description": { "type": "string", "description": "A description of any processing instructions supplied with the line Reference.", "default": "" }, "risk_codes": { "type": "array", "description": "The regulatory code(s) that are applicable to the Reference.", "items": { "type": "string", "default": "" } } }, "additionalProperties": false, "description": "The line reference information, which captures the line references in relating to the Contract or Section that is being underwritten. Also maintain the Risk Classification mapping against the line references." }, "response_participations_getall": { "required": [ "count", "page_number", "participations", "total_results", "page_size" ], "type": "object", "properties": { "participations": { "type": "array", "description": "List of participations retrieved", "items": { "$ref": "#/components/schemas/participation_getbyid" } }, "page_number": { "type": "integer", "description": "Number of the page retrieved", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 }, "total_results": { "type": "integer", "description": "Total number of results", "format": "int64", "example": 1234567891234567 }, "page_size": { "type": "integer", "description": "Size of the page retrieved", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "response_participations_getall_post": { "required": [ "count", "participations" ], "type": "object", "properties": { "participations": { "type": "array", "description": "List of participations retrieved", "items": { "$ref": "#/components/schemas/participation_getbyid" } }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "signed": { "required": [ "date", "line_percentage" ], "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "date": { "type": "string", "description": "The date and timestamp when the signed line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" } }, "additionalProperties": false, "description": "The signed line information, that the Broker has confirmed to the Underwriter." }, "signed_facility": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 } }, "additionalProperties": false, "description": "The signed line information, that the Broker has confirmed to the Underwriter, from the original master facility participation." }, "stamp_get": { "required": [ "agency_code", "agency_type", "name", "stamp_id", "status" ], "type": "object", "properties": { "stamp_id": { "type": "string", "description": "A system-generated unique identifier for a Stamp, with a format and structure defined by the technology used.", "default": "" }, "agency_type": { "type": "string", "description": "The code that represents the agency type.", "default": "" }, "agency_code": { "type": "string", "description": "The number that represents the stamp. For example this will be the 4-digit syndicate number for Lloyd's stamps.", "default": "" }, "name": { "type": "string", "description": "The legal name of the stamp, as provided by the Carrier organisation.", "default": "" }, "stamp_role": { "type": "string", "description": "The code that represents the role or roles that the stamp plays in this Participation.", "default": "" }, "written_line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "written_line_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "written_line_amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "calculated_line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage. The calculated signing down information.", "example": 0.1 }, "signed_line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage. The signed line information.", "example": 0.1 }, "line_conditions": { "type": "array", "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement.", "items": { "$ref": "#/components/schemas/line_condition_get" } }, "references": { "type": "array", "description": "The line reference information, which captures the line references in relating to the Contract or Section that is being underwritten. Also maintain the Risk Classification mapping against the line references.", "items": { "$ref": "#/components/schemas/reference_get" } }, "status": { "type": "string", "description": "The code that represents the status of the Stamp when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" } }, "additionalProperties": false, "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting." }, "stamp_postput": { "required": [ "stamp_id" ], "type": "object", "properties": { "stamp_id": { "type": "string", "description": "A system-generated unique identifier for a Stamp, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, "additionalProperties": false, "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting." }, "sub_panel_get": { "required": [ "name", "sequence_number", "sub_panel_id" ], "type": "object", "properties": { "sub_panel_id": { "type": "string", "description": "A system-generated unique identifier for a Sub Panel, with a format and structure defined by the technology used.", "default": "" }, "name": { "type": "string", "description": "The name of the sub panel.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number in which the Participations are ordered.", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "The sub panel information, identifying a group of Participations with a common set of underwriting terms." }, "sub_panel_postput": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the sub panel.", "default": "", "pattern": "^.{1,256}$" } }, "additionalProperties": false, "description": "The sub panel information, identifying a group of Participations with a common set of underwriting terms." }, "subjectivity_get": { "required": [ "confirmation_required", "description", "negotiation_status", "status", "subjectivity_id" ], "type": "object", "properties": { "subjectivity_id": { "type": "string", "description": "A system-generated unique identifier for a Subjectivity, with a format and structure defined by the technology used.", "default": "" }, "description": { "type": "string", "description": "A description of the subjectivity and any associated terms.", "default": "" }, "confirmation_required": { "type": "boolean", "description": "Indicates whether a subjectivity requires confirmation (true) or not (false).", "example": false }, "confirmation_required_by_date": { "type": "string", "description": "The date and timestamp by which the Subjectivity needs to be met.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "off_cover": { "type": "boolean", "description": "Indicates whether the Underwriter's participation is off-cover (true) until the Subjectivity is satisfied, or continues to be on cover (false).", "example": false }, "status": { "type": "string", "description": "The code that represents the status of the Subjectivity.", "default": "" }, "negotiation_status": { "type": "string", "description": "The code that represents the status of the Subjectivity when this is under negotiation.", "default": "" } }, "additionalProperties": false, "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy." }, "team_user": { "required": [ "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the User." }, "underwriter_team": { "required": [ "company_name", "organisation_name", "team_id", "team_name" ], "type": "object", "properties": { "team_id": { "type": "string", "description": "A system-generated unique identifier for a Underwriter Team, with a format and structure defined by the technology used.", "default": "" }, "team_name": { "type": "string", "description": "The name of the Underwriter Team, as defined by the carrier organisation.", "default": "" }, "organisation_name": { "type": "string", "description": "Name of the Organisation the User belongs to.", "default": "" }, "company_name": { "type": "string", "description": "Name of the Company the User belongs to.", "default": "" } }, "additionalProperties": false, "description": "The Team information of the Underwriter Team responsible for the Participation." }, "underwriter_user_participation": { "required": [ "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" }, "off_platform_underwriter": { "type": "boolean", "description": "Indicates whether the Underwriter User is registered as an off-platform user (true) or not (false).", "example": false } }, "additionalProperties": false, "description": "The User information of the Underwriter User responsible for the Participation." }, "written": { "required": [ "status" ], "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "date": { "type": "string", "description": "The date and timestamp when the written line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "status": { "type": "string", "description": "The code that represents the status of the written line when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" } }, "additionalProperties": false, "description": "The written underwriting line information, that the Underwriter is willing to accept." }, "written_facility": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The written underwriting line information, that the Underwriter is willing to accept, from the original master facility participation." }, "broker_team_company": { "required": [ "company_name", "team_id", "team_name" ], "type": "object", "properties": { "team_id": { "type": "string", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "default": "" }, "team_name": { "type": "string", "description": "The name of the Broker Team, as defined by the broker organisation.", "default": "" }, "company_name": { "type": "string", "description": "Name of the Company the User belongs to.", "default": "" } }, "additionalProperties": false, "description": "The team information of the Broker Team responsible for the node." }, "broker_user": { "required": [ "first_name", "last_name", "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the responsible Broker User." }, "health": { "type": "object", "properties": { "health": { "type": "string", "description": "health value", "default": "" } }, "description": "Health endpoint payload" }, "metadata": { "required": [ "created_by", "created_channel", "created_date", "modified_by", "modified_channel", "modified_date" ], "type": "object", "properties": { "created_date": { "type": "string", "description": "The date and timestamp when the entity was created.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "created_channel": { "type": "string", "description": "The mechanism used to create the entity, e.g. OutSystems, API", "default": "" }, "created_by": { "$ref": "#/components/schemas/metadata_user" }, "modified_date": { "type": "string", "description": "The date and timestamp when the entity was modified.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "modified_channel": { "type": "string", "description": "The mechanism used to modify the entity, e.g. OutSystems, API", "default": "" }, "modified_by": { "$ref": "#/components/schemas/metadata_user" } }, "additionalProperties": false, "description": "A collection of data items to support the creation and update of record entities." }, "metadata_user": { "required": [ "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the Metadata User." }, "contract_default_section_getall": { "required": [ "default_section_id", "period" ], "type": "object", "properties": { "default_section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "period": { "$ref": "#/components/schemas/period_getall" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" } }, "additionalProperties": false, "description": "The default section of the contract represents the summary of the overall risk to be insured under the Contract." }, "placement_broker_team": { "type": "object", "properties": { "team_id": { "type": "string", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "default": "" }, "team_name": { "type": "string", "description": "The name of the Broker Team, as defined by the broker organisation.", "default": "" }, "company_name": { "type": "string", "description": "Name of the Company the User belongs to.", "default": "" }, "branch_name": { "type": "string", "description": "Name of the Branch the Broker Team belongs to.", "default": "" } }, "additionalProperties": false, "description": "The team information of the Broker Team responsible for the Placement." }, "placement_contract_getbyid": { "required": [ "broker_team", "contract_id", "default_section_id" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "default_section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number that defines the order in which Contracts are ordered.", "format": "int32", "example": 0 }, "description": { "type": "string", "description": "A description of the Contract supplied by the Broker.", "default": "" }, "version": { "type": "string", "description": "The most recent version of the Contract", "default": "" }, "status": { "type": "string", "description": "The code that represents the Contract status.", "default": "" }, "broker_code": { "type": "string", "description": "A 4-digit Broker code that represents a broker organisation.", "default": "" }, "broker_contract_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract.", "default": "" }, "unique_market_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.", "default": "" }, "contract_type": { "type": "string", "description": "The code that represents the contract type.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "inception_date": { "type": "string", "description": "The date on which the (re)insurance contract/section comes into force.", "format": "date", "example": "2014-12-31" }, "expiry_date": { "type": "string", "description": "The date on which the (re)insurance contract/section ceases cover.", "format": "date", "example": "2014-12-31" }, "sections": { "type": "array", "description": "A representation of a specific partition of the overall risk to be insured. A section can be based upon the cover type, coverage (e.g. class of business) and/or layer (limit of liability).", "items": { "$ref": "#/components/schemas/placement_section_getbyid" } } }, "additionalProperties": false, "description": "A collection of insurance Contracts." }, "placement_getall": { "required": [ "broker_team", "client_name", "description", "effective_year", "placement_id" ], "type": "object", "properties": { "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "broker_team": { "$ref": "#/components/schemas/placement_broker_team" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "" }, "effective_year": { "type": "integer", "description": "The represented year in which the Placement is effective for.", "format": "int32", "example": 0 }, "earliest_inception_date": { "type": "string", "description": "The earliest inception date of all Contracts contained within the Placement structure.", "format": "date", "example": "2014-12-31T00:00:00.000Z" }, "status": { "type": "string", "description": "The code that represents the overall Placement status.", "default": "" }, "type": { "type": "string", "description": "The code that represents the Placement type.", "default": "" }, "programmes": { "type": "array", "description": "A collection of Contracts for a common purpose.", "items": { "$ref": "#/components/schemas/placement_programme_getall" } } }, "additionalProperties": false, "description": "Placement for Get All" }, "placement_getbyid": { "required": [ "broker_team", "client_name", "description", "effective_year", "placement_id" ], "type": "object", "properties": { "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "broker_team": { "$ref": "#/components/schemas/placement_broker_team" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "" }, "effective_year": { "type": "integer", "description": "The represented year in which the Placement is effective for.", "format": "int32", "example": 0 }, "earliest_inception_date": { "type": "string", "description": "The earliest inception date of all Contracts contained within the Placement structure.", "format": "date", "example": "2014-12-31" }, "status": { "type": "string", "description": "The code that represents the overall Placement status.", "default": "" }, "type": { "type": "string", "description": "The code that represents the Placement type.", "default": "" }, "programmes": { "type": "array", "description": "A collection of Contracts for a common purpose.", "items": { "$ref": "#/components/schemas/placement_programme_getbyid" } } }, "additionalProperties": false, "description": "Placement for Get By Id" }, "placement_programme_getall": { "required": [ "programme_id" ], "type": "object", "properties": { "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "" }, "earliest_inception_date": { "type": "string", "description": "The earliest inception date of all Contracts contained within the Programme structure.", "format": "date", "example": "2014-12-31T00:00:00.000Z" }, "status": { "type": "string", "description": "The code that represents the Programme status.", "default": "" } }, "additionalProperties": false, "description": "A collection of Contracts for a common purpose." }, "placement_post": { "required": [ "client_name", "description", "effective_year", "user_email" ], "type": "object", "properties": { "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "", "pattern": "^.{1,40}$" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "effective_year": { "type": "integer", "description": "The represented year in which the Placement is effective for.", "format": "int32", "minimum": 1900, "maximum": 9999, "example": 1900 }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Placement. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, "additionalProperties": false, "description": "Placement structure for creates" }, "placement_programme_getbyid": { "required": [ "broker_team", "programme_id" ], "type": "object", "properties": { "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "" }, "default": { "type": "boolean", "description": "Identifies whether this is a default Programme. A default Programme is a programme data structure where Contracts that are not within a business-related Programme are maintained.", "example": false }, "sequence_number": { "type": "integer", "description": "The sequence number in which differing Programmes are ordered.", "format": "int32", "example": 0 }, "broker_team": { "$ref": "#/components/schemas/broker_team_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "" }, "earliest_inception_date": { "type": "string", "description": "The earliest inception date of all Contracts contained within the Programme structure.", "format": "date", "example": "2014-12-31" }, "status": { "type": "string", "description": "The code that represents the Programme status.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "contracts": { "type": "array", "description": "A collection of insurance Contracts.", "items": { "$ref": "#/components/schemas/placement_contract_getbyid" } } }, "additionalProperties": false, "description": "A collection of Contracts for a common purpose." }, "placement_put": { "required": [ "client_name", "description", "effective_year", "user_email" ], "type": "object", "properties": { "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "", "pattern": "^.{1,40}$" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "effective_year": { "type": "integer", "description": "The represented year in which the Placement is effective for.", "format": "int32", "minimum": 1900, "maximum": 9999, "example": 1900 }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Placement. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" } }, "additionalProperties": false, "description": "Placement structure for updates" }, "placement_section_getbyid": { "required": [ "section_id" ], "type": "object", "properties": { "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "reference": { "type": "string", "description": "A reference of the Section supplied by the Broker.", "default": "" }, "description": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number that defines the order in which Sections are ordered.", "format": "int32", "example": 0 }, "status": { "type": "string", "description": "The code that represents the Section status.", "default": "" } }, "additionalProperties": false, "description": "A representation of a specific partition of the overall risk to be insured. A section can be based upon the cover type, coverage (e.g. class of business) and/or layer (limit of liability)." }, "version": { "type": "object", "properties": { "apiVersionNumber": { "type": "string", "description": "API Version Number", "default": "" }, "implementationVersion": { "type": "string", "description": "Implementation Version", "default": "" } }, "additionalProperties": false, "description": "Version endpoint payload" }, "programme_contract_getbyid": { "required": [ "contract_id", "unique_market_reference" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "unique_market_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.", "default": "" } }, "additionalProperties": false, "description": "A collection of insurance Contracts." }, "programme_contract_postput": { "required": [ "contract_id" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, "additionalProperties": false, "description": "" }, "programme_getbyid": { "required": [ "broker_team", "broker_user", "default", "description", "earliest_inception_date", "metadata", "placement_id", "programme_id", "sequence_number", "status" ], "type": "object", "properties": { "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "" }, "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "default": { "type": "boolean", "description": "Identifies whether this is a default Programme. A default Programme is a programme data structure where Contracts that are not within a business-related Programme are maintained.", "example": false }, "sequence_number": { "type": "integer", "description": "The sequence number in which differing Programmes are ordered.", "format": "int32", "example": 0 }, "broker_team": { "$ref": "#/components/schemas/broker_team_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "description": { "type": "string", "description": "A description of the Placement supplied by the Broker.", "default": "" }, "earliest_inception_date": { "type": "string", "description": "The earliest inception date of all Contracts contained within the Programme structure.", "format": "date", "example": "2014-12-31" }, "status": { "type": "string", "description": "The code that represents the Programme status.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "contracts": { "type": "array", "description": "A collection of insurance Contracts.", "items": { "$ref": "#/components/schemas/programme_contract_getbyid" } } }, "additionalProperties": false, "description": "A collection of Contracts for a common purpose." }, "programme_put": { "required": [ "description", "user_email" ], "type": "object", "properties": { "description": { "type": "string", "description": "A description of the Programme supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Programme. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "add_contracts": { "type": "array", "description": "A collection of insurance Contracts to be added to the Programme.", "items": { "$ref": "#/components/schemas/programme_contract_postput" } } }, "additionalProperties": false, "description": "Programme structure for updates" }, "programme_post": { "required": [ "description", "user_email" ], "type": "object", "properties": { "description": { "type": "string", "description": "A description of the Programme supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Programme. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "add_contracts": { "type": "array", "description": "A collection of insurance Contracts to be added to the Programme.", "items": { "$ref": "#/components/schemas/programme_contract_postput" } } }, "additionalProperties": false, "description": "Programme structure for creates" }, "response_contracts_getall": { "type": "object", "properties": { "contracts": { "type": "array", "description": "List of contracts retrieved", "items": { "$ref": "#/components/schemas/contract_getall" } }, "page_number": { "type": "integer", "description": "Number of the page retrieved", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 }, "total_results": { "type": "integer", "description": "Total number of results", "format": "int32", "example": 0 }, "page_size": { "type": "integer", "description": "Size of the page retrieved", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "response_placements_getall": { "type": "object", "properties": { "placements": { "type": "array", "description": "List of placements retrieved", "items": { "$ref": "#/components/schemas/placement_getall" } }, "page_number": { "type": "integer", "description": "Number of the page retrieved", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 }, "total_results": { "type": "integer", "description": "Total number of results", "format": "int32", "example": 0 }, "page_size": { "type": "integer", "description": "Size of the page retrieved", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "response_sections_getall": { "type": "object", "properties": { "sections": { "type": "array", "description": "List of sections retrieved", "items": { "$ref": "#/components/schemas/section_getall" } }, "page_number": { "type": "integer", "description": "Number of the page retrieved", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 }, "total_results": { "type": "integer", "description": "Total number of results", "format": "int32", "example": 0 }, "page_size": { "type": "integer", "description": "Size of the page retrieved", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "contract_default_section_getbyid": { "required": [ "default_section_id", "period", "stamp_permission_type" ], "type": "object", "properties": { "default_section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "period": { "$ref": "#/components/schemas/period" }, "geographic_coverage": { "$ref": "#/components/schemas/geographic_coverage" }, "conveyance_description": { "type": "string", "description": "A description of the subject matter insured or nature of liability.", "default": "" }, "interest_description": { "type": "string", "description": "A description of the interest insured or nature of liability.", "default": "" }, "order_type": { "type": "string", "description": "The code that represents the written line type, either a percentage or an amount.", "default": "" }, "order_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" }, "line_of_business": { "type": "string", "description": "The code that represents the line of business of the insurance product under this Contract or Section.", "default": "" }, "class_of_business": { "type": "string", "description": "The code that represents the class of business of the insurance product under this Contract or Section.", "default": "" }, "settlement_due_date": { "type": "string", "description": "The date and timestamp by when any instalment or payment of premium on this Contract or Section is expected to be paid to insurers.", "format": "date", "example": "2014-12-31" }, "installment_period_of_credit_days": { "type": "integer", "description": "The number of days of credit applied to when any instalment or payment of premium is due.", "format": "int32", "example": 0 }, "adjustment_period_of_credit_days": { "type": "integer", "description": "The number of days after the date(s) specified for the provision of adjustments that insurers expect the final adjustment(s) of premium (if any) to be paid.", "format": "int32", "example": 0 }, "stamp_permission_type": { "type": "string", "description": "The code that represents the permitted territory type for the Contract or Section.", "default": "" }, "year_of_account": { "type": "integer", "description": "The year of account to which any premium payment for this Contract or Section is allocated to. This is usually required on risks where the contract period exceeds 18 months.", "format": "int32", "example": 0 }, "risk_classification": { "type": "array", "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes.", "items": { "$ref": "#/components/schemas/section_risk" } }, "limits": { "type": "array", "description": "A collection of data items that represents the Limit(s) of any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_limit" } }, "excesses": { "type": "array", "description": "A collection of data items that represents the Excess(es) applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_excess" } }, "deductibles": { "type": "array", "description": "A collection of data items that represent the deductible(s) that are applied against the payment of a claim, within a Contract or Section.", "items": { "$ref": "#/components/schemas/section_deductible" } }, "premiums": { "type": "array", "description": "A collection of data items that represents the financial amount to cover the risk(s) under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_premium" } }, "binding_information": { "$ref": "#/components/schemas/section_binding_information" } }, "additionalProperties": false, "description": "The default section of the contract represents the summary of the overall risk to be insured under the Contract." }, "contract_default_section_postput": { "required": [ "period", "stamp_permission_type" ], "type": "object", "properties": { "period": { "$ref": "#/components/schemas/period" }, "geographic_coverage": { "$ref": "#/components/schemas/geographic_coverage" }, "conveyance_description": { "type": "string", "description": "A description of the subject matter insured or nature of liability.", "default": "", "pattern": "^.{1,512}$" }, "interest_description": { "type": "string", "description": "A description of the interest insured or nature of liability.", "default": "", "pattern": "^.{1,512}$" }, "order_type": { "type": "string", "description": "The code that represents the written line type, either a percentage or an amount.", "default": "" }, "order_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" }, "settlement_due_date": { "type": "string", "description": "The date and timestamp by when any instalment or payment of premium on this Contract or Section is expected to be paid to insurers.", "format": "date", "example": "2014-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "installment_period_of_credit_days": { "type": "integer", "description": "The number of days of credit applied to when any instalment or payment of premium is due.", "format": "int32", "example": 0 }, "adjustment_period_of_credit_days": { "type": "integer", "description": "The number of days after the date(s) specified for the provision of adjustments that insurers expect the final adjustment(s) of premium (if any) to be paid.", "format": "int32", "example": 0 }, "stamp_permission_type": { "type": "string", "description": "The code that represents the permitted territory type for the Contract or Section.", "default": "" }, "year_of_account": { "type": "integer", "description": "The year of account to which any premium payment for this Contract or Section is allocated to. This is usually required on risks where the contract period exceeds 18 months.", "format": "int32", "minimum": 1900, "maximum": 9999, "example": 1900 }, "risk_classification": { "type": "array", "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes.", "items": { "$ref": "#/components/schemas/section_risk" } }, "limits": { "type": "array", "description": "A collection of data items that represents the Limit(s) of any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_limit" } }, "excesses": { "type": "array", "description": "A collection of data items that represents the Excess(es) applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_excess" } }, "deductibles": { "type": "array", "description": "A collection of data items that represent the deductible(s) that are applied against the payment of a claim, within a Contract or Section.", "items": { "$ref": "#/components/schemas/section_deductible" } }, "premiums": { "type": "array", "description": "A collection of data items that represents the financial amount to cover the risk(s) under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_premium" } } }, "additionalProperties": false, "description": "The default section of the contract represents the summary of the overall risk to be insured under the Contract." }, "contract_getall": { "required": [ "broker_code", "broker_contract_reference", "broker_team", "broker_user", "client_name", "contract_id", "contract_type", "default_section", "description", "firm_order_ready", "metadata", "placement_id", "programme_id", "quote_ready", "status", "unique_market_reference", "version" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "" }, "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "description": { "type": "string", "description": "A description of the Contract supplied by the Broker.", "default": "" }, "broker_code": { "type": "string", "description": "A 4-digit Broker code that represents a broker organisation.", "default": "" }, "broker_contract_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract.", "default": "" }, "unique_market_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.", "default": "" }, "contract_type": { "type": "string", "description": "The code that represents the contract type.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Contract status.", "default": "" }, "firm_order_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Firm Order (true) or not (false).", "example": false }, "quote_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Quote (true) or not (false).", "example": false }, "version": { "type": "integer", "description": "The current version of the Contract.", "format": "int32", "example": 0 }, "default_section": { "$ref": "#/components/schemas/contract_default_section_getall" } }, "additionalProperties": false, "description": "Contract for Get All" }, "contract_getbyid": { "required": [ "broker_code", "broker_contract_reference", "broker_team", "broker_user", "client_name", "contract_id", "contract_type", "default_section", "description", "firm_order_ready", "metadata", "placement_id", "programme_id", "quote_ready", "sequence_number", "status", "unique_market_reference", "version" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "client_name": { "type": "string", "description": "The name by which the Broker User knows the client for the purposes of seeking insurance.", "default": "" }, "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team_company" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "sequence_number": { "type": "integer", "description": "The sequence number in which the Contracts are ordered.", "format": "int32", "example": 0 }, "description": { "type": "string", "description": "A description of the Contract supplied by the Broker.", "default": "" }, "broker_code": { "type": "string", "description": "A 4-digit Broker code that represents a broker organisation.", "default": "" }, "broker_contract_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract.", "default": "" }, "unique_market_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.", "default": "" }, "contract_type": { "type": "string", "description": "The code that represents the contract type.", "default": "" }, "cover_type": { "type": "string", "description": "The code that represents the cover type.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Contract status.", "default": "" }, "firm_order_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Firm Order (true) or not (false).", "example": false }, "quote_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Quote (true) or not (false).", "example": false }, "insureds": { "type": "array", "description": "A collection of individuals or organisations, and their relationship within a contract of insurance.", "items": { "$ref": "#/components/schemas/contract_insured" } }, "backload_indicator": { "type": "boolean", "description": "Indicates that the Contract has been backloaded (true) or not (false) into the platform.", "example": false }, "backload_reason_code": { "type": "string", "description": "The code that represents the backload reason.", "default": "" }, "backload_description": { "type": "string", "description": "A description about the backload of a Contract.", "default": "" }, "version": { "type": "integer", "description": "The current version of the Contract.", "format": "int32", "example": 0 }, "first_sign_and_close_date": { "type": "string", "description": "The date and timestamp of when a contract was first signed and closed.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "default_section": { "$ref": "#/components/schemas/contract_default_section_getbyid" }, "sections": { "type": "array", "description": "A representation of a specific partition of the overall risk to be insured. A section can be based upon the cover type, coverage (e.g. class of business) and/or layer (limit of liability).", "items": { "$ref": "#/components/schemas/contract_section_getbyid" } } }, "additionalProperties": false, "description": "Contract for Get By Id" }, "contract_insured": { "required": [ "name", "role" ], "type": "object", "properties": { "name": { "type": "string", "description": "The legal name of the insured, reinsured or retrocedent under the terms of a contract of insurance.", "default": "", "pattern": "^.{1,256}$" }, "role": { "type": "string", "description": "The type of role that a particular individual or organisation is involved in, under the terms of a contract of insurance.", "default": "" } }, "additionalProperties": false, "description": "An individual or organisation, and their relationship within a contract of insurance." }, "contract_put": { "required": [ "broker_code", "broker_contract_reference", "default_section", "description", "placement_id", "user_email", "version" ], "type": "object", "properties": { "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "description": { "type": "string", "description": "A description of the Contract supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Contract. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "broker_code": { "type": "string", "description": "A 4-digit Broker code that represents a broker organisation.", "default": "", "pattern": "^\\d{4}$" }, "broker_contract_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract.", "default": "", "pattern": "^[A-Z0-9]{1,12}$" }, "contract_type": { "type": "string", "description": "The code that represents the contract type.", "default": "" }, "cover_type": { "type": "string", "description": "The code that represents the cover type.", "default": "" }, "insureds": { "type": "array", "description": "A collection of individuals or organisations, and their relationship within a contract of insurance.", "items": { "$ref": "#/components/schemas/contract_insured" } }, "version": { "type": "integer", "description": "The current version of the Contract.", "format": "int32", "example": 0 }, "default_section": { "$ref": "#/components/schemas/contract_default_section_postput" } }, "additionalProperties": false, "description": "Contract structure for updates" }, "contract_post": { "required": [ "broker_code", "broker_contract_reference", "default_section", "description", "placement_id", "user_email" ], "type": "object", "properties": { "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "programme_id": { "type": "string", "description": "A system-generated unique identifier for a Programme, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "description": { "type": "string", "description": "A description of the Contract supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "user_email": { "type": "string", "description": "The User information of the Broker User responsible for the Contract. The email address of the User.", "default": "", "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" }, "broker_code": { "type": "string", "description": "A 4-digit Broker code that represents a broker organisation.", "default": "", "pattern": "^\\d{4}$" }, "broker_contract_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract.", "default": "", "pattern": "^[A-Z0-9]{1,12}$" }, "contract_type": { "type": "string", "description": "The code that represents the contract type.", "default": "" }, "cover_type": { "type": "string", "description": "The code that represents the cover type.", "default": "" }, "insureds": { "type": "array", "description": "A collection of individuals or organisations, and their relationship within a contract of insurance.", "items": { "$ref": "#/components/schemas/contract_insured" } }, "default_section": { "$ref": "#/components/schemas/contract_default_section_postput" } }, "additionalProperties": false, "description": "Contract structure for creates" }, "contract_section_getbyid": { "required": [ "section_id" ], "type": "object", "properties": { "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "reference": { "type": "string", "description": "A reference of the Section supplied by the Broker.", "default": "" }, "description": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number that defines the order in which Sections are ordered.", "format": "int32", "example": 0 }, "status": { "type": "string", "description": "The code that represents the Section status.", "default": "" } }, "additionalProperties": false, "description": "A representation of a specific partition of the overall risk to be insured. A section can be based upon the cover type, coverage (e.g. class of business) and/or layer (limit of liability)." }, "geographic_coverage": { "required": [ "code", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "indicates the type of the geographic coverage, either as a single country or a geographic region.", "default": "" }, "code": { "type": "string", "description": "The code that represents the value of the country or region based on the geographic coverage type.", "default": "" }, "description": { "type": "string", "description": "A high level description of the situation, territorial limits or scope, trading warranties or location.", "default": "", "pattern": "^.{1,512}$" } }, "additionalProperties": false, "description": "A collection of data items to represent the territory of cover for a Contract or Section." }, "period": { "type": "object", "properties": { "period_date": { "$ref": "#/components/schemas/period_date" }, "period_range": { "$ref": "#/components/schemas/period_range" } }, "additionalProperties": false, "description": "A collection of data items to denote the Contract or Section period." }, "period_date": { "required": [ "expiry_date", "inception_date" ], "type": "object", "properties": { "inception_date": { "type": "string", "description": "The date on which the (re)insurance Contract or Section comes into force.", "format": "date", "example": "2014-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "expiry_date": { "type": "string", "description": "The date on which the (re)insurance Contract or Section ceases cover.", "format": "date", "example": "2014-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "qualifier_type": { "type": "string", "description": "The code that represents the period qualifier type.", "default": "" }, "qualifier_description": { "type": "string", "description": "A description of the period qualifier, captured when there is a no alignment to the reference data code.", "default": "", "pattern": "^.{1,256}$" } }, "additionalProperties": false, "description": "A collection of data items to denote the Contract or Section period using specific dates." }, "period_date_getall": { "required": [ "expiry_date", "inception_date" ], "type": "object", "properties": { "inception_date": { "type": "string", "description": "The date on which the (re)insurance Contract or Section comes into force.", "format": "date", "example": "2014-12-31T00:00:00.000Z" }, "expiry_date": { "type": "string", "description": "The date on which the (re)insurance Contract or Section ceases cover.", "format": "date", "example": "2014-12-31T00:00:00.000Z" } }, "additionalProperties": false, "description": "A collection of data items to denote the Contract or Section period using specific dates." }, "period_getall": { "type": "object", "properties": { "period_date": { "$ref": "#/components/schemas/period_date_getall" }, "period_range": { "$ref": "#/components/schemas/period_range" } }, "additionalProperties": false, "description": "A collection of data items to denote the Contract or Section period." }, "period_range": { "required": [ "duration_number", "duration_unit" ], "type": "object", "properties": { "duration_number": { "type": "integer", "description": "An integer value representing the numeric element of a Period Range.", "format": "int32", "example": 1, "minimum": 1 }, "duration_unit": { "type": "string", "description": "The code that represents the unit of measurement element of a Period Range.", "default": "" } }, "additionalProperties": false, "description": "A collection of data items to denote the Contract or Section period, as a numeric and unit of measurement." }, "section_binding_information": { "type": "object", "properties": { "signed_line_basis": { "type": "string", "description": "The basis upon which all signed lines are applied to the Order of a Contract or Section.", "default": "" } }, "additionalProperties": false, "description": "The Binding Information relevant to a Contract or Section." }, "section_deductible": { "required": [ "amount", "basis_type", "currency_code", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The code that represents the type of deductible.", "default": "" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The deductible amount applicable under the terms of the insurance Contract or Section.", "example": 0.1 }, "basis_type": { "type": "string", "description": "The code that represents the basis of the deductible.", "default": "" }, "type_description": { "type": "string", "description": "A bespoke description of the deductible type, where not provisioned under the existing reference data type codes.", "default": "", "pattern": "^.{1,512}$" }, "basis_description": { "type": "string", "description": "A bespoke description of the deductible basis type, where not provisioned under the existing reference data basis type codes.", "default": "", "pattern": "^.{1,512}$" } }, "additionalProperties": false, "description": "A collection of data items that represent the deductible(s) that are applied against the payment of a claim, within a Contract or Section." }, "section_excess": { "required": [ "amount", "basis_type", "currency_code", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The code that represents the type of excess.", "default": "" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The excess amount applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "example": 0.1 }, "basis_type": { "type": "string", "description": "The code that represents the basis of the excess.", "default": "" }, "type_description": { "type": "string", "description": "A bespoke description of the excess type, where not provisioned under the existing reference data type codes.", "default": "", "pattern": "^.{1,512}$" }, "basis_description": { "type": "string", "description": "A bespoke description of the excess basis type, where not provisioned under the existing reference data basis type codes.", "default": "", "pattern": "^.{1,512}$" } }, "additionalProperties": false, "description": "A collection of data items that represents the Excess(es) applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section." }, "section_limit": { "required": [ "amount", "basis_type", "currency_code", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The code that represents the type of limit.", "default": "" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The limit amount the insurer has agreed to cover under the terms of the insurance Contract or Section.", "example": 0.1 }, "basis_type": { "type": "string", "description": "The code that represents the basis of the limit.", "default": "" }, "type_description": { "type": "string", "description": "A bespoke description of the limit type, where not provisioned under the existing reference data type codes.", "default": "", "pattern": "^.{1,512}$" }, "basis_description": { "type": "string", "description": "A bespoke description of the limit basis type, where not provisioned under the existing reference data basis type codes.", "default": "", "pattern": "^.{1,512}$" } }, "additionalProperties": false, "description": "A collection of data items that represents the Limit(s) of any liability the insurer has agreed to cover under the terms of the insurance Contract or Section." }, "section_premium": { "required": [ "basis_type", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The code that represents the type of premium.", "default": "" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "number", "description": "The premium amount applicable under the terms of the insurance Contract or Section.", "example": 0.1 }, "rate": { "type": "number", "description": "The premium rate applicable under the terms of the insurance Contract or Section.", "example": 0.1 }, "rate_unit": { "type": "string", "description": "The code that represents the unit of measurement to be applied to the premium rate.", "default": "" }, "basis_type": { "type": "string", "description": "The code that represents the basis of the premium.", "default": "" }, "type_description": { "type": "string", "description": "A bespoke description of the premium type, where not provisioned under the existing reference data type codes.", "default": "", "pattern": "^.{1,512}$" }, "basis_description": { "type": "string", "description": "A bespoke description of the premium basis type, where not provisioned under the existing reference data basis type codes.", "default": "", "pattern": "^.{1,512}$" } }, "additionalProperties": false, "description": "A collection of data items that represents the financial amount to cover the risk(s) under the terms of the insurance Contract or Section." }, "section_risk": { "required": [ "allocation_percentage", "risk_code" ], "type": "object", "properties": { "risk_code": { "type": "string", "description": "The regulatory code that represents the risk for a risk classification.", "default": "" }, "allocation_percentage": { "type": "number", "description": "The percentage of the total premium that is deemed to be the allocation of covering a particular risk code.", "example": 0.1 } }, "additionalProperties": false, "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes." }, "section_getall": { "required": [ "contract_id", "description", "firm_order_ready", "metadata", "period", "placement_id", "quote_ready", "reference", "section_id", "sequence_number", "status" ], "type": "object", "properties": { "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "reference": { "type": "string", "description": "A reference of the Section supplied by the Broker.", "default": "" }, "description": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number that defines the order in which Sections are ordered.", "format": "int32", "example": 0 }, "status": { "type": "string", "description": "The code that represents the Section status.", "default": "" }, "firm_order_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Firm Order (true) or not (false).", "example": false }, "quote_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Quote (true) or not (false).", "example": false }, "period": { "$ref": "#/components/schemas/period" }, "geographic_coverage": { "$ref": "#/components/schemas/geographic_coverage" }, "conveyance_description": { "type": "string", "description": "A description of the subject matter insured or nature of liability.", "default": "" }, "interest_description": { "type": "string", "description": "A description of the interest insured or nature of liability.", "default": "" }, "order_type": { "type": "string", "description": "The code that represents the written line type, either a percentage or an amount.", "default": "" }, "order_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" }, "stamp_permission_type": { "type": "string", "description": "The code that represents the permitted territory type for the Contract or Section.", "default": "" } }, "additionalProperties": false, "description": "The default section of the contract represents the summary of the overall risk to be insured under the Contract." }, "section_getbyid": { "required": [ "contract_id", "description", "firm_order_ready", "metadata", "period", "placement_id", "quote_ready", "reference", "section_id", "sequence_number", "status", "stamp_permission_type" ], "type": "object", "properties": { "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "placement_id": { "type": "string", "description": "A system-generated unique identifier for a Placement, with a format and structure defined by the technology used.", "default": "" }, "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "reference": { "type": "string", "description": "A reference of the Section supplied by the Broker.", "default": "" }, "description": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "" }, "sequence_number": { "type": "integer", "description": "The sequence number that defines the order in which Sections are ordered.", "format": "int32", "example": 0 }, "status": { "type": "string", "description": "The code that represents the Section status.", "default": "" }, "firm_order_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Firm Order (true) or not (false).", "example": false }, "quote_ready": { "type": "boolean", "description": "Indicates whether the Contract is ready to submit as a Quote (true) or not (false).", "example": false }, "period": { "$ref": "#/components/schemas/period" }, "geographic_coverage": { "$ref": "#/components/schemas/geographic_coverage" }, "conveyance_description": { "type": "string", "description": "A description of the subject matter insured or nature of liability.", "default": "" }, "interest_description": { "type": "string", "description": "A description of the interest insured or nature of liability.", "default": "" }, "order_type": { "type": "string", "description": "The code that represents the written line type, either a percentage or an amount.", "default": "" }, "order_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" }, "line_of_business": { "type": "string", "description": "The code that represents the line of business of the insurance product under this Contract or Section.", "default": "" }, "class_of_business": { "type": "string", "description": "The code that represents the class of business of the insurance product under this Contract or Section.", "default": "" }, "settlement_due_date": { "type": "string", "description": "The date and timestamp by when any instalment or payment of premium on this Contract or Section is expected to be paid to insurers.", "format": "date", "example": "2014-12-31" }, "installment_period_of_credit_days": { "type": "integer", "description": "The number of days of credit applied to when any instalment or payment of premium is due.", "format": "int32", "example": 0 }, "adjustment_period_of_credit_days": { "type": "integer", "description": "The number of days after the date(s) specified for the provision of adjustments that insurers expect the final adjustment(s) of premium (if any) to be paid.", "format": "int32", "example": 0 }, "stamp_permission_type": { "type": "string", "description": "The code that represents the permitted territory type for the Contract or Section.", "default": "" }, "year_of_account": { "type": "integer", "description": "The year of account to which any premium payment for this Contract or Section is allocated to. This is usually required on risks where the contract period exceeds 18 months.", "format": "int32", "example": 0 }, "risk_classification": { "type": "array", "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes.", "items": { "$ref": "#/components/schemas/section_risk" } }, "limits": { "type": "array", "description": "A collection of data items that represents the Limit(s) of any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_limit" } }, "excesses": { "type": "array", "description": "A collection of data items that represents the Excess(es) applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_excess" } }, "deductibles": { "type": "array", "description": "A collection of data items that represent the deductible(s) that are applied against the payment of a claim, within a Contract or Section.", "items": { "$ref": "#/components/schemas/section_deductible" } }, "premiums": { "type": "array", "description": "A collection of data items that represents the financial amount to cover the risk(s) under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_premium" } }, "binding_information": { "$ref": "#/components/schemas/section_binding_information" } }, "additionalProperties": false, "description": "The default section of the contract represents the summary of the overall risk to be insured under the Contract." }, "section_postput": { "required": [ "description", "period", "reference", "stamp_permission_type" ], "type": "object", "properties": { "reference": { "type": "string", "description": "A reference of the Section supplied by the Broker.", "default": "", "pattern": "^[a-zA-Z0-9.,<>/\\\\@'#~;:\\[\\]{}!\"£$%^&*()_+=]{1,12}$" }, "description": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "", "pattern": "^.{1,256}$" }, "period": { "$ref": "#/components/schemas/period" }, "geographic_coverage": { "$ref": "#/components/schemas/geographic_coverage" }, "conveyance_description": { "type": "string", "description": "A description of the subject matter insured or nature of liability.", "default": "", "pattern": "^.{1,512}$" }, "interest_description": { "type": "string", "description": "A description of the interest insured or nature of liability.", "default": "", "pattern": "^.{1,512}$" }, "order_type": { "type": "string", "description": "The code that represents the written line type, either a percentage or an amount.", "default": "" }, "order_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "", "pattern": "^[A-Z]{3}$" }, "order_percentage": { "type": "number", "description": "The amount or percentage of the insured's risk that is covered by this Contract or Section.", "example": 0.1 }, "written_line_basis": { "type": "string", "description": "The basis upon which all written lines are applied to the Order of a Contract or Section.", "default": "" }, "product_code": { "type": "string", "description": "The code that represents the insurance product under this Contract or Section.", "default": "" }, "settlement_due_date": { "type": "string", "description": "The date and timestamp by when any instalment or payment of premium on this Contract or Section is expected to be paid to insurers.", "format": "date", "example": "2014-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "installment_period_of_credit_days": { "type": "integer", "description": "The number of days of credit applied to when any instalment or payment of premium is due.", "format": "int32", "example": 0 }, "adjustment_period_of_credit_days": { "type": "integer", "description": "The number of days after the date(s) specified for the provision of adjustments that insurers expect the final adjustment(s) of premium (if any) to be paid.", "format": "int32", "example": 0 }, "stamp_permission_type": { "type": "string", "description": "The code that represents the permitted territory type for the Contract or Section.", "default": "" }, "year_of_account": { "type": "integer", "description": "The year of account to which any premium payment for this Contract or Section is allocated to. This is usually required on risks where the contract period exceeds 18 months.", "format": "int32", "minimum": 1900, "maximum": 9999, "example": 1900 }, "risk_classification": { "type": "array", "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes.", "items": { "$ref": "#/components/schemas/section_risk" } }, "limits": { "type": "array", "description": "A collection of data items that represents the Limit(s) of any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_limit" } }, "excesses": { "type": "array", "description": "A collection of data items that represents the Excess(es) applicable prior to any liability the insurer has agreed to cover under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_excess" } }, "deductibles": { "type": "array", "description": "A collection of data items that represent the deductible(s) that are applied against the payment of a claim, within a Contract or Section.", "items": { "$ref": "#/components/schemas/section_deductible" } }, "premiums": { "type": "array", "description": "A collection of data items that represents the financial amount to cover the risk(s) under the terms of the insurance Contract or Section.", "items": { "$ref": "#/components/schemas/section_premium" } } }, "additionalProperties": false, "description": "Section structure for creates and updates" }, "broker_team": { "required": [ "team_id", "team_name" ], "type": "object", "properties": { "team_id": { "type": "string", "description": "A system-generated unique identifier for a Broker Team, with a format and structure defined by the technology used.", "default": "" }, "team_name": { "type": "string", "description": "The name of the Broker Team, as defined by the broker organisation.", "default": "" } }, "additionalProperties": false, "description": "The team information of the Broker Team responsible for the node." }, "comment_user": { "required": [ "first_name", "last_name", "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the User." }, "placement_negotiation_amount": { "type": "object", "properties": { "value": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "comments_history": { "type": "array", "description": "Array of comments on the Line Percentage Negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The specified underwriting value, as an amount." }, "placement_negotiation_amount_postput": { "type": "object", "properties": { "comment": { "type": "string", "description": "Latest comment on the negotiation of a differing Written Line Amount than that proposed by the Broker.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The specified underwriting value, as an amount." }, "placement_negotiation_calculated": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 } }, "additionalProperties": false, "description": "The calculated signing down information, following the Broker invoking the signing down process in the Section." }, "placement_negotiation_comments": { "required": [ "comment", "date", "user" ], "type": "object", "properties": { "date": { "type": "string", "description": "The date and timestamp when the comment was provided.", "format": "date", "example": "2014-12-31T00:00:00.000Z" }, "comment": { "type": "string", "description": "The Sender comment specific for a negotiable data attribute.", "default": "" }, "user": { "$ref": "#/components/schemas/comment_user" } }, "additionalProperties": false, "description": "Array of comments for Negotiation usage." }, "placement_negotiation_contract_document": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "The code that represents the status of the Contract Document comments.", "default": "" }, "comments_history": { "type": "array", "description": "Array of comments on the Contract Document Comments negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The negotiation pertaining to the content of the Contract Document." }, "placement_negotiation_contract_document_postput": { "type": "object", "properties": { "accept_contract_document_comments": { "type": "boolean", "description": "Identifies when the Broker accepts the Underwriter comments made to the Contract Document (true) or not (false).", "example": false }, "comment": { "type": "string", "description": "Latest comment on the negotiation of comments made to the Contract Document.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The negotiation pertaining to the content of the Contract Document." }, "placement_negotiation_facility_panel": { "required": [ "facility_panel_id", "master_facility" ], "type": "object", "properties": { "facility_panel_id": { "type": "string", "description": "A system-generated unique identifier for a Facility Panel, with a format and structure defined by the technology used.", "default": "" }, "proposed": { "$ref": "#/components/schemas/placement_negotiation_facility_panel_proposed" }, "written": { "$ref": "#/components/schemas/placement_negotiation_facility_panel_written" }, "calculated": { "$ref": "#/components/schemas/placement_negotiation_facility_panel_calculated" }, "signed": { "$ref": "#/components/schemas/placement_negotiation_facility_panel_signed" }, "master_facility": { "$ref": "#/components/schemas/placement_negotiation_facility_panel_master" } }, "additionalProperties": false, "description": "The Facility Panel information, holding values from the Master Facility as a whole. This information will be consistent across all Participation records which originate from the same Master Facility." }, "placement_negotiation_facility_panel_calculated": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 } }, "additionalProperties": false, "description": "The calculated signing down information, following the Broker invoking the signing down process in the Section." }, "placement_negotiation_facility_panel_master": { "required": [ "facility_contract_id", "section_id", "section_name", "unique_market_reference" ], "type": "object", "properties": { "facility_contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "unique_market_reference": { "type": "string", "description": "The reference allocated by the broker to identify the Contract for use within the placement process, as a concatenation of the Broker Code and Broker Contract Reference.", "default": "" }, "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "section_name": { "type": "string", "description": "A description of the Section supplied by the Broker.", "default": "" } }, "additionalProperties": false, "description": "" }, "placement_negotiation_facility_panel_proposed": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The proposed underwriting line information, that the Broker is proposing to the Underwriter." }, "placement_negotiation_facility_panel_signed": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "date": { "type": "string", "description": "The date and timestamp when the signed line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" } }, "additionalProperties": false, "description": "The signed line information, that the Broker has confirmed to the Underwriter." }, "placement_negotiation_facility_panel_written": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "date": { "type": "string", "description": "The date and timestamp when the written line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" } }, "additionalProperties": false, "description": "The written underwriting line information, that the Underwriter is willing to accept." }, "placement_negotiation_getall": { "required": [ "broker_team", "broker_user", "contract_id", "contract_version", "has_line_conditions", "has_subjectivities", "is_leader", "metadata", "negotiation_id", "order_limit", "order_percentage", "participation_id", "personal_message", "responding_to_negotiation_id", "section_id", "sent_by_user", "status", "status_reason", "submission_id", "type", "underwriter_team", "underwriter_user", "written_line_basis" ], "type": "object", "properties": { "negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "responding_to_negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used. The identifier Negotiation record that this record is in response to.", "default": "" }, "submission_id": { "type": "string", "description": "A system-generated unique identifier for a Submission, with a format and structure defined by the technology used.", "default": "" }, "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "contract_version": { "type": "integer", "description": "The contract version this negotiation respects to.", "format": "int32", "example": 0 }, "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "participation_id": { "type": "string", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "underwriter_team": { "$ref": "#/components/schemas/underwriter_team_only_name" }, "underwriter_user": { "$ref": "#/components/schemas/underwriter_user" }, "sent_by_user": { "$ref": "#/components/schemas/sent_by_user" }, "personal_message": { "type": "string", "description": "A personal message from the broker in relation to the Underwriter's Participation.", "default": "" }, "type": { "type": "string", "description": "The type of the Negotiation.", "default": "" }, "sub_type": { "type": "string", "description": "The subtype of the Negotiation.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Negotiation status, based upon the Type of Negotiation.", "default": "" }, "status_reason": { "type": "string", "description": "The code that represents the reason for the Negotiation status", "default": "" }, "written_line_basis": { "type": "string", "description": "The basis on which the underwriter's written lines are applied to the Order of a Contract or Section.", "default": "" }, "signed_line_basis": { "type": "string", "description": "The basis on which the underwriter's signed lines are applied to the Order of a Contract or Section.", "default": "" }, "order_percentage": { "type": "number", "description": "The basis upon which all signed lines are applied to the Order of a Contract or Section.", "example": 0.1 }, "order_limit": { "type": "number", "description": "The value to be used as part of the signing down process, where the Order is expressed as a monetary amount.", "example": 0.1 }, "is_leader": { "type": "boolean", "description": "Parameter used to return Negotiations records that have a leader role (true) or not (false).", "example": false }, "roles": { "type": "array", "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead.", "items": { "$ref": "#/components/schemas/placement_negotiation_role" } }, "has_line_conditions": { "type": "boolean", "description": "Parameter used to return Negotiation records that have at least one Line Condition (true) or no Line Conditions (false) present in any Stamp within a Participation, irrespective of the Status of the Line Condition.", "example": false }, "has_subjectivities": { "type": "boolean", "description": "Parameter used to return Negotiation records that have at least one Subjectivity (true) or no Subjectivities (false) present.", "example": false } }, "additionalProperties": false, "description": "Negotiation structure for Get All" }, "placement_negotiation_getbyid": { "required": [ "broker_team", "broker_user", "contract_id", "contract_version", "has_line_conditions", "is_draft", "last_sent_status", "metadata", "negotiation_id", "order_limit", "order_percentage", "participation_id", "personal_message", "proposed", "responding_to_negotiation_id", "risk_classification_agreed", "section_id", "sent_by_user", "sent_by_user_message", "settlement_agreed", "status", "status_reason", "submission_id", "type", "underwriter_team", "underwriter_user", "written_line_basis" ], "type": "object", "properties": { "negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "responding_to_negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used. The identifier Negotiation record that this record is in response to.", "default": "" }, "submission_id": { "type": "string", "description": "A system-generated unique identifier for a Submission, with a format and structure defined by the technology used.", "default": "" }, "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "contract_version": { "type": "integer", "description": "The contract version this negotiation respects to.", "format": "int32", "example": 0 }, "section_id": { "type": "string", "description": "A system-generated unique identifier for a Section, with a format and structure defined by the technology used.", "default": "" }, "participation_id": { "type": "string", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used.", "default": "" }, "broker_team": { "$ref": "#/components/schemas/broker_team" }, "broker_user": { "$ref": "#/components/schemas/broker_user" }, "underwriter_team": { "$ref": "#/components/schemas/underwriter_team_only_name" }, "underwriter_user": { "$ref": "#/components/schemas/underwriter_user" }, "sent_by_user": { "$ref": "#/components/schemas/sent_by_user" }, "personal_message": { "type": "string", "description": "A personal message from the broker in relation to the Underwriter's Participation.", "default": "" }, "sub_panel": { "$ref": "#/components/schemas/placement_negotiation_sub_panel" }, "type": { "type": "string", "description": "The type of the Negotiation.", "default": "" }, "sub_type": { "type": "string", "description": "The subtype of the Negotiation.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Negotiation status, based upon the Type of Negotiation.", "default": "" }, "status_reason": { "type": "string", "description": "The code that represents the reason for the Negotiation status", "default": "" }, "last_sent_status": { "type": "string", "description": "The code that represents the status of the last sent Negotiation.", "default": "" }, "written_line_basis": { "type": "string", "description": "The basis on which the underwriter's written lines are applied to the Order of a Contract or Section.", "default": "" }, "signed_line_basis": { "type": "string", "description": "The basis on which the underwriter's signed lines are applied to the Order of a Contract or Section.", "default": "" }, "order_percentage": { "type": "number", "description": "The basis upon which all signed lines are applied to the Order of a Contract or Section.", "example": 0.1 }, "order_limit": { "type": "number", "description": "The value to be used as part of the signing down process, where the Order is expressed as a monetary amount.", "example": 0.1 }, "sent_by_user_message": { "type": "string", "description": "The user message specific for a negotiable data attribute.", "default": "" }, "settlement_agreed": { "type": "boolean", "description": "Indicates when the Contract or Section Leader has agreed (true) the Settlement terms, or not (false).", "example": false }, "settlement": { "$ref": "#/components/schemas/placement_negotiation_settlement" }, "year_of_account": { "type": "integer", "description": "The year of account to which any premium payment for this Contract or Section is allocated to. This is usually required on risks where the contract period exceeds 18 months.", "format": "int32", "example": 0 }, "proposed": { "$ref": "#/components/schemas/placement_negotiation_proposed" }, "written": { "$ref": "#/components/schemas/placement_negotiation_written" }, "calculated": { "$ref": "#/components/schemas/placement_negotiation_calculated" }, "signed": { "$ref": "#/components/schemas/placement_negotiation_signed" }, "roles": { "type": "array", "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead.", "items": { "$ref": "#/components/schemas/placement_negotiation_role_plus" } }, "has_line_conditions": { "type": "boolean", "description": "Parameter used to return Negotiation records that have at least one Line Condition (true) or no Line Conditions (false) present in any Stamp within a Participation, irrespective of the Status of the Line Condition.", "example": false }, "risk_classification_agreed": { "type": "boolean", "description": "Indicates when the Risk Classification information has been agreed (true) by either the Lloyd's or LIC Leader of the Contract or Section, or not (false).", "example": false }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp" } }, "subjectivities": { "type": "array", "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy.", "items": { "$ref": "#/components/schemas/placement_negotiation_subjectivity" } }, "contract_document": { "$ref": "#/components/schemas/placement_negotiation_contract_document" }, "is_draft": { "type": "boolean", "description": "Identifies whether the negotiation is saved as a draft (true) or not (false). It should always be false after the negotiation is sent, and only updated to true when the negotiation or its parent Submission is formally sent to the other party.", "example": false }, "save_response": { "$ref": "#/components/schemas/placement_negotiation_save_response" }, "facility_panel": { "$ref": "#/components/schemas/placement_negotiation_facility_panel" }, "leaders": { "type": "array", "description": "A collection of contractual leadership information, where applicable.", "items": { "$ref": "#/components/schemas/placement_negotiation_leader" } } }, "additionalProperties": false, "description": "Negotiation structure for Get by Identifier" }, "placement_negotiation_leader": { "required": [ "company_name", "role", "stamp", "underwriter_leader" ], "type": "object", "properties": { "underwriter_leader": { "$ref": "#/components/schemas/underwriter_user" }, "company_name": { "type": "string", "description": "Name of the Company the User belongs to.", "default": "" }, "role": { "type": "string", "description": "The code that represents the role or roles that the Underwriter plays through their participation.", "default": "" }, "status": { "type": "string", "description": "The code that represents the status of the role when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "written": { "$ref": "#/components/schemas/placement_negotiation_leader_written" }, "stamp": { "$ref": "#/components/schemas/placement_negotiation_leader_stamp" } }, "additionalProperties": false, "description": "" }, "placement_negotiation_leader_stamp": { "required": [ "agency_code", "agency_type", "name", "percentage_of_total_written_line", "stamp_role" ], "type": "object", "properties": { "agency_type": { "type": "string", "description": "The code that represents the agency type.", "default": "" }, "agency_code": { "type": "string", "description": "The number that represents the stamp. For example this will be the 4-digit syndicate number for Lloyd's stamps.", "default": "" }, "name": { "type": "string", "description": "The legal name of the stamp, as provided by the Carrier organisation.", "default": "" }, "stamp_role": { "type": "string", "description": "The code that represents the role or roles that the stamp plays in this Participation.", "default": "" }, "percentage_of_total_written_line": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "written_line_absolute_percentage": { "type": "number", "description": "The specified underwriting value, as an absolute percentage of a Stamp.", "example": 0.1 }, "written_line_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "written_line_amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "" }, "placement_negotiation_leader_written": { "type": "object", "properties": { "line_percentage": { "$ref": "#/components/schemas/placement_negotiation_leader_written_line_percenta" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "$ref": "#/components/schemas/placement_negotiation_leader_written_amount" } }, "additionalProperties": false, "description": "" }, "placement_negotiation_leader_written_amount": { "type": "object", "properties": { "value": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "" }, "placement_negotiation_leader_written_line_percenta": { "type": "object", "properties": { "value": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 } }, "additionalProperties": false, "description": "" }, "placement_negotiation_line_percentage": { "type": "object", "properties": { "value": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "comments_history": { "type": "array", "description": "Array of comments on the Line Percentage Negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The specified underwriting value, as a percentage." }, "placement_negotiation_line_percentage_postput": { "type": "object", "properties": { "comment": { "type": "string", "description": "Latest comment on the negotiation of a differing Written Line Percentage than that proposed by the Broker.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The specified underwriting value, as a percentage." }, "placement_negotiation_post": { "required": [ "responding_to_negotiation_id", "status" ], "type": "object", "properties": { "responding_to_negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used. The identifier Negotiation record that this record is in response to.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "status": { "type": "string", "description": "The code that represents the Negotiation status, based upon the Type of Negotiation.", "default": "" }, "sent_by_user_message": { "type": "string", "description": "The user message specific for a negotiable data attribute.", "default": "", "pattern": "^.{1,8000}$" }, "written": { "$ref": "#/components/schemas/placement_negotiation_written_postput" }, "roles": { "type": "array", "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead.", "items": { "$ref": "#/components/schemas/placement_negotiation_role_postput" } }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_postput" } }, "subjectivities": { "type": "array", "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy.", "items": { "$ref": "#/components/schemas/placement_negotiation_subjectivity_post" } }, "contract_document": { "$ref": "#/components/schemas/placement_negotiation_contract_document_postput" } }, "additionalProperties": false, "description": "Negotiation structure for creates" }, "placement_negotiation_proposed": { "type": "object", "properties": { "min_line_percentage": { "type": "number", "description": "The minimum underwriting value, as a percentage.", "example": 0.1 }, "max_line_percentage": { "type": "number", "description": "The maximum underwriting value, as a percentage.", "example": 0.1 }, "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "min_amount": { "type": "number", "description": "The minimum underwriting value, as an amount.", "example": 0.1 }, "max_amount": { "type": "number", "description": "The maximum underwriting value, as an amount.", "example": 0.1 }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The proposed underwriting line information, that the Broker is proposing to the Underwriter." }, "placement_negotiation_put": { "required": [ "responding_to_negotiation_id", "status" ], "type": "object", "properties": { "responding_to_negotiation_id": { "type": "string", "description": "A system-generated unique identifier for a Negotiation, with a format and structure defined by the technology used. The identifier Negotiation record that this record is in response to.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "status": { "type": "string", "description": "The code that represents the Negotiation status, based upon the Type of Negotiation.", "default": "" }, "sent_by_user_message": { "type": "string", "description": "The user message specific for a negotiable data attribute.", "default": "", "pattern": "^.{1,8000}$" }, "written": { "$ref": "#/components/schemas/placement_negotiation_written_postput" }, "roles": { "type": "array", "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead.", "items": { "$ref": "#/components/schemas/placement_negotiation_role_postput" } }, "stamps": { "type": "array", "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_postput" } }, "subjectivities": { "type": "array", "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy.", "items": { "$ref": "#/components/schemas/placement_negotiation_subjectivity_post" } }, "contract_document": { "$ref": "#/components/schemas/placement_negotiation_contract_document_postput" } }, "additionalProperties": false, "description": "Negotiation structure for updates" }, "placement_negotiation_role": { "required": [ "status", "role" ], "type": "object", "properties": { "status": { "type": "string", "description": "The code that represents the status of the role when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "role": { "type": "string", "description": "The code that represents the role or roles that the Underwriter plays through their participation.", "default": "" } }, "additionalProperties": false, "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead." }, "placement_negotiation_role_plus": { "required": [ "role", "status" ], "type": "object", "properties": { "role": { "type": "string", "description": "The code that represents the role or roles that the Underwriter plays through their participation.", "default": "" }, "status": { "type": "string", "description": "The code that represents the status of the role when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "comments_history": { "type": "array", "description": "Array of comments on the roles Negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead." }, "placement_negotiation_role_postput": { "required": [ "accept_decline_role_indicator", "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The code that represents the role or roles that the Underwriter plays through their participation.", "default": "" }, "accept_decline_role_indicator": { "type": "boolean", "description": "dentifies whether declined contractual role has been accepted (true) or not (false). ", "example": false }, "comment": { "type": "string", "description": "Latest comment on the negotiation of declining the contractual role proposed by the Broker.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "A mapping between Participation and Participation Role Type. This allows multiple roles to be captured against a single participation, for example both Slip Lead and Lloyd's Lead." }, "placement_negotiation_save_response": { "required": [ "date", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/comment_user" }, "date": { "type": "string", "description": "The date and timestamp of the User responsible for saving the Negotiation record.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" } }, "additionalProperties": false, "description": "Information about the saving of the Negotiation record." }, "placement_negotiation_settlement": { "required": [ "adjustment_period_of_credit_days", "installment_period_of_credit_days", "settlement_due_date" ], "type": "object", "properties": { "settlement_due_date": { "type": "string", "description": "The date and timestamp by when any instalment or payment of premium on this Contract or Section is expected to be paid to insurers.", "format": "date", "example": "2014-12-31T00:00:00.000Z" }, "installment_period_of_credit_days": { "type": "integer", "description": "The number of days of credit applied to when any instalment or payment of premium is due.", "format": "int32", "example": 0 }, "adjustment_period_of_credit_days": { "type": "integer", "description": "The number of days after the date(s) specified for the provision of adjustments that insurers expect the final adjustment(s) of premium (if any) to be paid.", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "" }, "placement_negotiation_signed": { "type": "object", "properties": { "line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage.", "example": 0.1 }, "date": { "type": "string", "description": "The date and timestamp when the signed line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 } }, "additionalProperties": false, "description": "The signed line information, that the Broker has confirmed to the Underwriter." }, "placement_negotiation_stamp": { "required": [ "agency_code", "agency_type", "name", "stamp_id", "status" ], "type": "object", "properties": { "stamp_id": { "type": "string", "description": "A system-generated unique identifier for a Stamp, with a format and structure defined by the technology used.", "default": "" }, "agency_type": { "type": "string", "description": "The code that represents the agency type.", "default": "" }, "agency_code": { "type": "string", "description": "The number that represents the stamp. For example this will be the 4-digit syndicate number for Lloyd's stamps.", "default": "" }, "name": { "type": "string", "description": "The legal name of the stamp, as provided by the Carrier organisation.", "default": "" }, "stamp_role": { "type": "string", "description": "The code that represents the role or roles that the stamp plays in this Participation.", "default": "" }, "percentage_of_total_written_line": { "type": "number", "description": "The specified underwriting value, as a proportion of 100 percent of the overall negotiation.", "example": 0.1 }, "written_line_absolute_percentage": { "type": "number", "description": "The specified underwriting value, as an absolute percentage of a Stamp.", "example": 0.1 }, "written_line_currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "written_line_amount": { "type": "number", "description": "The specified underwriting value, as an amount.", "example": 0.1 }, "calculated_line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage. The calculated signing down information.", "example": 0.1 }, "signed_line_percentage": { "type": "number", "description": "The specified underwriting value, as a percentage. The signed line information.", "example": 0.1 }, "risk_classification": { "type": "array", "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_risk_code" } }, "line_conditions": { "type": "array", "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_line_condition" } }, "references": { "type": "array", "description": "The line reference information, which captures the line references in relating to the Contract or Section that is being underwritten. Also maintain the Risk Classification mapping against the line references.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_reference" } }, "status": { "type": "string", "description": "The code that represents the status of the Stamp when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "comments_history": { "type": "array", "description": "Array of comments on the stamps negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting." }, "placement_negotiation_stamp_line_condition": { "required": [ "code", "description", "line_condition_id", "status" ], "type": "object", "properties": { "line_condition_id": { "type": "string", "description": "A system-generated unique identifier for a Line Condition, with a format and structure defined by the technology used.", "default": "" }, "description": { "type": "string", "description": "A description of the line condition.", "default": "" }, "status": { "type": "string", "description": "The code that represents the status of the line condition when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" }, "code": { "type": "string", "description": "The code that identifies whether a line condition is global line condition that functionally impacts platform behaviour.", "default": "" }, "comments_history": { "type": "array", "description": "Array of comments on the stamps' line conditions negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement." }, "placement_negotiation_stamp_line_condition_postput": { "required": [ "accept_line_condition_indicator", "line_condition_id" ], "type": "object", "properties": { "line_condition_id": { "type": "string", "description": "A system-generated unique identifier for a Line Condition, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "accept_line_condition_indicator": { "type": "boolean", "description": "Identifies whether the line condition has been accepted (true) or not (false). ", "example": false }, "comment": { "type": "string", "description": "Latest comment on the negotiation of a Carrier Stamp's Line Condition proposed by the Underwriter.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement." }, "placement_negotiation_stamp_postput": { "required": [ "accept_stamp_indicator", "stamp_id" ], "type": "object", "properties": { "stamp_id": { "type": "string", "description": "A system-generated unique identifier for a Stamp, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "line_conditions": { "type": "array", "description": "The Line Condition information, identifying the Line Condition itself, the status of its agreement.", "items": { "$ref": "#/components/schemas/placement_negotiation_stamp_line_condition_postput" } }, "accept_stamp_indicator": { "type": "boolean", "description": "Identifies whether the stamp has been accepted (true) or not (false). ", "example": false }, "comment": { "type": "string", "description": "Latest comment on the negotiation of a Carrier Stamp proposed by the Underwriter.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The Stamp information, identifying information about the underwriting entity, roles and line references to said underwriting." }, "placement_negotiation_stamp_reference": { "required": [ "description", "reference" ], "type": "object", "properties": { "reference": { "type": "string", "description": "The reference allocated by the underwriter against the Stamp.", "default": "" }, "description": { "type": "string", "description": "A description of any processing instructions supplied with the line Reference.", "default": "" }, "risk_codes": { "type": "array", "description": "The regulatory code(s) that are applicable to the Reference.", "items": { "type": "string", "default": "" } } }, "additionalProperties": false, "description": "" }, "placement_negotiation_stamp_risk_code": { "required": [ "code", "percentage" ], "type": "object", "properties": { "code": { "type": "string", "description": "The regulatory code that represents the risk for a risk classification.", "default": "" }, "percentage": { "type": "number", "description": "The percentage of the total premium that is deemed to be the allocation of covering a particular risk code.", "example": 0.1 } }, "additionalProperties": false, "description": "A collection of data items to represent the regulatory risk classification for a Contract or Section. Only supports Lloyds Agency Type Risk Codes." }, "placement_negotiation_sub_panel": { "required": [ "name", "sub_panel_id" ], "type": "object", "properties": { "sub_panel_id": { "type": "string", "description": "A system-generated unique identifier for a Sub Panel, with a format and structure defined by the technology used.", "default": "" }, "name": { "type": "string", "description": "The name of the sub panel.", "default": "" } }, "additionalProperties": false, "description": "The sub panel information, identifying a group of Participations with a common set of underwriting terms." }, "placement_negotiation_subjectivity": { "required": [ "confirmation_required", "description", "negotiation_status", "off_cover_indicator", "saved_as_accepted", "saved_as_declined", "status", "subjectivity_id" ], "type": "object", "properties": { "subjectivity_id": { "type": "string", "description": "A system-generated unique identifier for a Subjectivity, with a format and structure defined by the technology used.", "default": "" }, "description": { "type": "string", "description": "A description of the subjectivity and any associated terms.", "default": "" }, "confirmation_required": { "type": "boolean", "description": "Indicates whether a subjectivity requires confirmation (true) or not (false).", "example": false }, "confirmation_required_by_date": { "type": "string", "description": "The date and timestamp by which the Subjectivity needs to be met.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "off_cover_indicator": { "type": "boolean", "description": "Indicates whether the Underwriter's participation is off-cover (true) until the Subjectivity is satisfied, or continues to be on cover (false).", "example": false }, "status": { "type": "string", "description": "The code that represents the status of the Subjectivity.", "default": "" }, "negotiation_status": { "type": "string", "description": "The code that represents the status of the Subjectivity when this is under negotiation.", "default": "" }, "withdrawn_date": { "type": "string", "description": "The date and timestamp on which the Subjectivity was withdrawn.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "saved_as_accepted": { "type": "boolean", "description": "Identifies when the Subjectivity under review from the Broker is marked as Accepted (true) or not (false).", "example": false }, "saved_as_declined": { "type": "boolean", "description": "Identifies when the Subjectivity under review is marked as Declined (true) or not (false).", "example": false }, "comments_history": { "type": "array", "description": "Array of comments on the subjectivities negotiation.", "items": { "$ref": "#/components/schemas/placement_negotiation_comments" } } }, "additionalProperties": false, "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy." }, "placement_negotiation_subjectivity_post": { "required": [ "subjectivity_id" ], "type": "object", "properties": { "subjectivity_id": { "type": "string", "description": "A system-generated unique identifier for a Subjectivity, with a format and structure defined by the technology used.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" }, "saved_as_accepted": { "type": "boolean", "description": "Identifies when the Subjectivity under review from the Broker is marked as Accepted (true) or not (false).", "example": false }, "comment": { "type": "string", "description": "Latest comment on the negotiation of a Subjectivity proposed by the Underwriter.", "default": "", "pattern": "^.{1,8000}$" } }, "additionalProperties": false, "description": "The Subjectivity information, identifying the Subjectivity itself, the status of cover prior to its agreement/satisfaction and any deadline applied to satisfy." }, "placement_negotiation_written": { "required": [ "status" ], "type": "object", "properties": { "line_percentage": { "$ref": "#/components/schemas/placement_negotiation_line_percentage" }, "currency_code": { "type": "string", "description": "The 3-character code that represents the currency in ISO 4217 standard.", "default": "" }, "amount": { "$ref": "#/components/schemas/placement_negotiation_amount" }, "date": { "type": "string", "description": "The date and timestamp when the written line was provided.", "format": "date-time", "example": "2014-12-31T23:59:59.938Z" }, "status": { "type": "string", "description": "The code that represents the status of the written line when this is under negotiation, i.e. differs from that which was originally proposed.", "default": "" } }, "additionalProperties": false, "description": "The written underwriting line information, that the Underwriter is willing to accept." }, "placement_negotiation_written_postput": { "required": [ "accept_written_line_indicator" ], "type": "object", "properties": { "line_percentage": { "$ref": "#/components/schemas/placement_negotiation_line_percentage_postput" }, "amount": { "$ref": "#/components/schemas/placement_negotiation_amount_postput" }, "accept_written_line_indicator": { "type": "boolean", "description": "dentifies whether the written line has been accepted (true) or not (false). ", "example": false } }, "additionalProperties": false, "description": "The written underwriting line information, that the Underwriter is willing to accept." }, "response_placement_negotiations_getall": { "required": [ "count", "negotiations", "page_number", "page_size", "total_results" ], "type": "object", "properties": { "negotiations": { "type": "array", "description": "List of negotiations retrieved", "items": { "$ref": "#/components/schemas/placement_negotiation_getall" } }, "page_number": { "type": "integer", "description": "Number of the page retrieved", "format": "int32", "example": 0 }, "page_size": { "type": "integer", "description": "Size of the page retrieved", "format": "int32", "example": 0 }, "count": { "type": "integer", "description": "The number of records on the current page", "format": "int32", "example": 0 }, "total_results": { "type": "integer", "description": "Total number of results", "format": "int64", "example": 1234567891234567 } }, "additionalProperties": false, "description": "" }, "sent_by_user": { "required": [ "first_name", "last_name", "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the User." }, "underwriter_team_only_name": { "required": [ "team_name" ], "type": "object", "properties": { "team_name": { "type": "string", "description": "The name of the Underwriter Team, as defined by the carrier organisation.", "default": "" } }, "additionalProperties": false, "description": "The Team information of the Underwriter Team responsible for the Participation." }, "underwriter_user": { "required": [ "user_email" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The email address of the User.", "default": "" }, "first_name": { "type": "string", "description": "The first name of the User.", "default": "" }, "last_name": { "type": "string", "description": "The last name of the User.", "default": "" } }, "additionalProperties": false, "description": "The User information of the Underwriter User responsible for the Participation." }, "contract_assignroles": { "type": "object", "properties": { "slip_leader_participation_id": { "type": "string", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used. This represents the Contract Leader or Slip Leader from among the selection of Underwriter candidates that are Section Leaders within the same Contract.", "default": "", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$" } }, "additionalProperties": false, "description": "Contract input structure for assign roles" }, "contract_assignroles_output": { "required": [ "contract_id", "metadata", "notification" ], "type": "object", "properties": { "contract_id": { "type": "string", "description": "A system-generated unique identifier for a Contract, with a format and structure defined by the technology used.", "default": "" }, "metadata": { "$ref": "#/components/schemas/metadata" }, "slip_leader_participation_id": { "type": "string", "description": "A system-generated unique identifier for a Participation, with a format and structure defined by the technology used. This represents the Contract Leader or Slip Leader from among the selection of Underwriter candidates that are Section Leaders within the same Contract.", "default": "" }, "notification": { "$ref": "#/components/schemas/notification" } }, "additionalProperties": false, "description": "Contract output structure for assign roles" }, "notification": { "required": [ "category_type", "notification_id", "status", "type" ], "type": "object", "properties": { "notification_id": { "type": "string", "description": "A system-generated unique identifier for a Notification, with a format and structure defined by the technology used.", "default": "" }, "category_type": { "type": "string", "description": "Identifies the category type of the notification that is being processed in an asynchronous manner.", "default": "" }, "type": { "type": "string", "description": "Identifies the type of notification that is being processed in an asynchronous manner.", "default": "" }, "status": { "type": "string", "description": "The code that represents the Notification status.", "default": "" } }, "additionalProperties": false, "description": "The Notification information relating to the Document. " }, "error": { "type": "object", "properties": { "message": { "type": "string", "nullable": true, "description": "The error message." }, "argument": { "type": "string", "nullable": true, "description": "The syntax argument used to validate the field against (if on syntax validation)." }, "field": { "type": "string", "nullable": true, "description": "The field where the error occurred (if field specific)." }, "code": { "type": "string", "description": "The error code." } } }, "error_document": { "type": "object", "description": "The error document.", "properties": { "errors": { "type": "array", "description": "A collection of errors. The list may be empty.", "items": { "$ref": "#/components/schemas/error" } } } } } } }