{ "openapi": "3.0.1", "info": { "title": "TMF 632 - API Party", "description": "## TMF API Reference : TMF 632 - Party ### Release : 19.0 The party API provides standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events. Party can be an individual or an organization that has any kind of relation with the enterprise. Party is created to record individual or organization information before the assignment of any role. For example, within the context of a split billing mechanism, Party API allows creation of the individual or organization that will play the role of 3 rd payer for a given offer and, then, allows consultation or update of his information. ### Resources - Organization - Individual - Hub Party API performs the following operations : - Retrieve an organization or an individual - Retrieve a collection of organizations or individuals according to given criteria - Create a new organization or a new individual - Update an existing organization or an existing individual - Delete an existing organization or an existing individual - Notify events on organizatin or individual", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "4.0.0" }, "externalDocs": { "description": "TMF API Tables", "url": "https://www.tmforum.org/oda/open-apis/table" }, "servers": [ { "url": "https://portal.openslice.eu/tmf-api", "description": "Generated server url" } ], "security": [ { "security_auth": [] } ], "tags": [ { "name": "individual", "description": "the individual API" }, { "name": "listener", "description": "the listener API" }, { "name": "organization", "description": "the organization API" }, { "name": "hub", "description": "the hub API" } ], "paths": { "/party/v4/organization": { "get": { "tags": [ "organization" ], "summary": "List or find Organization objects", "description": "This operation list or find Organization entities", "operationId": "listOrganization", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } } } }, "post": { "tags": [ "organization" ], "summary": "Creates a Organization", "description": "This operation creates a Organization entity.", "operationId": "createOrganization", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/party/v4/listener/organizationStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity OrganizationStateChangeEvent", "description": "Example of a client listener for receiving the notification OrganizationStateChangeEvent", "operationId": "listenToOrganizationStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/organizationDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity OrganizationDeleteEvent", "description": "Example of a client listener for receiving the notification OrganizationDeleteEvent", "operationId": "listenToOrganizationDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/organizationCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity OrganizationCreateEvent", "description": "Example of a client listener for receiving the notification OrganizationCreateEvent", "operationId": "listenToOrganizationCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/organizationAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity OrganizationAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification OrganizationAttributeValueChangeEvent", "operationId": "listenToOrganizationAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/individualStateChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity IndividualStateChangeEvent", "description": "Example of a client listener for receiving the notification IndividualStateChangeEvent", "operationId": "listenToIndividualStateChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualStateChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/individualDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity IndividualDeleteEvent", "description": "Example of a client listener for receiving the notification IndividualDeleteEvent", "operationId": "listenToIndividualDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/individualCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity IndividualCreateEvent", "description": "Example of a client listener for receiving the notification IndividualCreateEvent", "operationId": "listenToIndividualCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/listener/individualAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity IndividualAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification IndividualAttributeValueChangeEvent", "operationId": "listenToIndividualAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/individual": { "get": { "tags": [ "individual" ], "summary": "List or find Individual objects", "description": "This operation list or find Individual entities", "operationId": "listIndividual", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } } } } }, "post": { "tags": [ "individual" ], "summary": "Creates a Individual", "description": "This operation creates a Individual entity.", "operationId": "createIndividual", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } } } } }, "/party/v4/hub": { "post": { "tags": [ "hub", "events subscription" ], "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "registerListener", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscriptionInput" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Subscribed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/party/v4/organization/{id}": { "get": { "tags": [ "organization" ], "summary": "Retrieves a Organization by ID", "description": "This operation retrieves a Organization entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Organization", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "delete": { "tags": [ "organization" ], "summary": "Deletes a Organization", "description": "This operation deletes a Organization entity.", "operationId": "deleteOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Organization", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "organization" ], "summary": "Updates partially a Organization", "description": "This operation updates partially a Organization entity.", "operationId": "patchOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrganizationUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/party/v4/individual/{id}": { "get": { "tags": [ "individual" ], "summary": "Retrieves a Individual by ID", "description": "This operation retrieves a Individual entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveIndividual", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Individual", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } } } }, "delete": { "tags": [ "individual" ], "summary": "Deletes a Individual", "description": "This operation deletes a Individual entity.", "operationId": "deleteIndividual", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Individual", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "individual" ], "summary": "Updates partially a Individual", "description": "This operation updates partially a Individual entity.", "operationId": "patchIndividual", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Individual", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/IndividualUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Individual" } } } } } } }, "/party/v4/hub/{id}": { "delete": { "tags": [ "hub", "events subscription" ], "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "unregisterListener", "parameters": [ { "name": "id", "in": "path", "description": "The id of the registered listener", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "400": { "description": "Bad request" }, "204": { "description": "Deleted" }, "405": { "description": "Method not allowed" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" } } } } }, "components": { "schemas": { "Any": { "type": "object", "properties": { "value": { "type": "string" }, "alias": { "type": "string" } }, "description": "The value of the characteristic" }, "AttachmentRefOrValue": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier for this particular attachment", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture", "example": "video" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@referredType": { "type": "string" } }, "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture." }, "Characteristic": { "required": [ "value" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "value": { "$ref": "#/components/schemas/Any" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "ContactMedium": { "required": [ "characteristic", "mediumType" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "mediumType": { "type": "string", "description": "Type of the contact medium, such as: email address, telephone number, postal address" }, "preferred": { "type": "boolean", "description": "If true, indicates that is the preferred contact medium" }, "characteristic": { "$ref": "#/components/schemas/MediumCharacteristic" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Indicates the contact medium that could be used to contact the party." }, "ExternalReference": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "externalReferenceType": { "type": "string", "description": "Type of the external reference" } }, "description": "External reference of the individual or reference in other system" }, "MediumCharacteristic": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "city": { "type": "string", "description": "The city" }, "contactType": { "type": "string", "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation\u2026" }, "country": { "type": "string", "description": "The country" }, "emailAddress": { "type": "string", "description": "Full email address in standard format" }, "faxNumber": { "type": "string", "description": "The fax number of the contact" }, "phoneNumber": { "type": "string", "description": "The primary phone number of the contact" }, "postCode": { "type": "string", "description": "Postcode" }, "socialNetworkId": { "type": "string", "description": "Identifier as a member of a social network" }, "stateOrProvince": { "type": "string", "description": "State or province" }, "street1": { "type": "string", "description": "Describes the street" }, "street2": { "type": "string", "description": "Complementary street description" } }, "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)" }, "OrganizationChildRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "relationshipType": { "type": "string", "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." }, "organization": { "$ref": "#/components/schemas/OrganizationRef" } }, "description": "Child references of an organization in a structure of organizations." }, "OrganizationCreate": { "type": "object", "properties": { "isHeadOffice": { "type": "boolean", "description": "If value is true, the organization is the head office" }, "isLegalEntity": { "type": "boolean", "description": "If value is true, the organization is a legal entity known by a national referential." }, "name": { "type": "string", "description": "Organization name (department name for example)" }, "nameType": { "type": "string", "description": "Type of the name : Co, Inc, Ltd,\u2026" }, "organizationType": { "type": "string", "description": "Type of Organization (company, department...)" }, "tradingName": { "type": "string", "description": "Name that the organization (unit) trades under" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "existsDuring": { "$ref": "#/components/schemas/TimePeriod" }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "organizationChildRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationChildRelationship" } }, "organizationIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationIdentification" } }, "organizationParentRelationship": { "$ref": "#/components/schemas/OrganizationParentRelationship" }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/OtherNameOrganization" } }, "partyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "status": { "type": "string", "description": "Status of the organization", "enum": [ "initialized", "validated", "closed" ] }, "taxExemptionCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The Organization to be created" }, "OrganizationIdentification": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "identificationId": { "type": "string", "description": "Identifier" }, "identificationType": { "type": "string", "description": "Type of identification information used to identify the company in a country or internationally" }, "issuingAuthority": { "type": "string", "description": "Authority which has issued the identifier (chamber of commerce...)" }, "issuingDate": { "type": "string", "format": "date-time" }, "attachment": { "$ref": "#/components/schemas/AttachmentRefOrValue" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Represents our registration of information used as proof of identity by an organization" }, "OrganizationParentRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "relationshipType": { "type": "string", "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." }, "organization": { "$ref": "#/components/schemas/OrganizationRef" } }, "description": "Parent references of an organization in a structure of organizations." }, "OrganizationRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string", "description": "Unique identifier of a related entity." } } }, "OtherNameOrganization": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "nameType": { "type": "string", "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" }, "tradingName": { "type": "string", "description": "The name that the organization trades under" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Keeps track of other names, for example the old name of an organization." }, "PartyCreditProfile": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "creditAgencyName": { "type": "string", "description": "Name of the credit agency giving the score" }, "creditAgencyType": { "type": "string", "description": "Type of the credit agency giving the score" }, "ratingReference": { "type": "string", "description": "Reference corresponding to the credit rating" }, "ratingScore": { "type": "integer", "description": "A measure of a party\u2019s creditworthiness calculated on the basis of a combination of factors such as their income and credit history", "format": "int32" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency." }, "Quantity": { "type": "object", "properties": { "amount": { "type": "number", "description": "Numeric value in a given unit", "format": "float" }, "units": { "type": "string", "description": "Unit" } }, "description": "An amount in a given unit" }, "RelatedParty": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "role": { "type": "string", "description": "Role of the related party." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" }, "extendedInfo": { "type": "string" } }, "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." }, "TaxDefinition": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "taxType": { "type": "string", "description": "Type of the tax." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string", "description": "Unique identifier of the tax." } }, "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,\u2026)." }, "TaxExemptionCertificate": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string", "description": "Unique identifier of the certificate of the tax exemption" }, "attachment": { "$ref": "#/components/schemas/AttachmentRefOrValue" }, "taxDefinition": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxDefinition" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition." }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "Organization": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier of the organization" }, "isHeadOffice": { "type": "boolean", "description": "If value is true, the organization is the head office" }, "isLegalEntity": { "type": "boolean", "description": "If value is true, the organization is a legal entity known by a national referential." }, "nameType": { "type": "string", "description": "Type of the name : Co, Inc, Ltd,\u2026" }, "organizationType": { "type": "string", "description": "Type of Organization (company, department...)" }, "tradingName": { "type": "string", "description": "Name that the organization (unit) trades under" }, "contactMedium": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "existsDuring": { "$ref": "#/components/schemas/TimePeriod" }, "externalReference": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "organizationChildRelationship": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/OrganizationChildRelationship" } }, "organizationIdentification": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/OrganizationIdentification" } }, "organizationParentRelationship": { "$ref": "#/components/schemas/OrganizationParentRelationship" }, "otherName": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/OtherNameOrganization" } }, "partyCharacteristic": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "status": { "type": "string", "description": "Status of the organization", "enum": [ "initialized", "validated", "closed" ] }, "taxExemptionCertificate": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } } }, "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data." }, "OrganizationStateChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/OrganizationStateChangeEventPayload" } }, "description": "The event data" }, "OrganizationStateChangeEventPayload": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "description": "The event data structure" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "OrganizationDeleteEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/OrganizationDeleteEventPayload" } }, "description": "The event data" }, "OrganizationDeleteEventPayload": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "description": "The event data structure" }, "OrganizationCreateEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/OrganizationCreateEventPayload" } }, "description": "The event data" }, "OrganizationCreateEventPayload": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "description": "The event data structure" }, "OrganizationAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/OrganizationAttributeValueChangeEventPayload" } }, "description": "The event data" }, "OrganizationAttributeValueChangeEventPayload": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "description": "The event data structure" }, "Disability": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "disabilityCode": { "type": "string", "description": "Code of the disability" }, "disabilityName": { "type": "string", "description": "Name of the disability" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Lack or inadequate strength or ability." }, "Individual": { "type": "object", "properties": { "uuid": { "type": "string" }, "birthDate": { "type": "string", "description": "Birth date" }, "deathDate": { "type": "string", "description": "Date of death" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string", "description": "Unique identifier of the organization" }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl,\u2026" }, "countryOfBirth": { "type": "string", "description": "Country where the individual was born" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "formattedName": { "type": "string", "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" }, "fullName": { "type": "string", "description": "Full name flatten (first, middle, and last names)" }, "gender": { "type": "string", "description": "Gender" }, "generation": { "type": "string", "description": "e.g.. Sr, Jr, III (the third),\u2026" }, "givenName": { "type": "string", "description": "First name of the individual" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "location": { "type": "string", "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" }, "maritalStatus": { "type": "string", "description": "Marital status (married, divorced, widow ...)" }, "middleName": { "type": "string", "description": "Middles name or initial" }, "nationality": { "type": "string", "description": "Nationality" }, "placeOfBirth": { "type": "string", "description": "Reference to the place where the individual was born" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "title": { "type": "string", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." }, "contactMedium": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "disability": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Disability" } }, "externalReference": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "individualIdentification": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/IndividualIdentification" } }, "languageAbility": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/LanguageAbility" } }, "otherName": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/OtherNameIndividual" } }, "partyCharacteristic": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "skill": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "status": { "type": "string", "description": "Status of the individual", "enum": [ "initialized", "validated", "deceaded" ] }, "taxExemptionCertificate": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } } }, "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about." }, "IndividualIdentification": { "type": "object", "properties": { "uuid": { "type": "string" }, "issuingDate": { "type": "string", "description": "Date at which the identifier was issued" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "identificationId": { "type": "string", "description": "Identifier" }, "identificationType": { "type": "string", "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" }, "issuingAuthority": { "type": "string", "description": "Authority which has issued the identifier, such as: social security, town hall" }, "attachment": { "$ref": "#/components/schemas/AttachmentRefOrValue" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)" }, "IndividualStateChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/IndividualStateChangeEventPayload" } }, "description": "The event data" }, "IndividualStateChangeEventPayload": { "type": "object", "properties": { "individual": { "$ref": "#/components/schemas/Individual" } }, "description": "The event data structure" }, "LanguageAbility": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "isFavouriteLanguage": { "type": "boolean", "description": "A \u201ctrue\u201d value specifies whether the language is considered by the individual as his favourite one" }, "languageCode": { "type": "string", "description": "Language code (RFC 5646)" }, "languageName": { "type": "string", "description": "Language name" }, "listeningProficiency": { "type": "string", "description": "Listening proficiency evaluated for this language" }, "readingProficiency": { "type": "string", "description": "Reading proficiency evaluated for this language" }, "speakingProficiency": { "type": "string", "description": "Speaking proficiency evaluated for this language" }, "writingProficiency": { "type": "string", "description": "Writing proficiency evaluated for this language" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Ability of an individual to understand or converse in a language." }, "OtherNameIndividual": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl,\u2026" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "formattedName": { "type": "string", "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" }, "fullName": { "type": "string", "description": "Full name flatten (first, middle, and last names)" }, "generation": { "type": "string", "description": "e.g. Sr, Jr\u2026" }, "givenName": { "type": "string", "description": "First name" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "middleName": { "type": "string", "description": "Middle name or initial" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "title": { "type": "string", "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name." }, "Skill": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "comment": { "type": "string", "description": "A free text comment linked to the evaluation done" }, "evaluatedLevel": { "type": "string", "description": "Level of expertise in a skill evaluated for an individual" }, "skillCode": { "type": "string", "description": "Code of the skill" }, "skillName": { "type": "string", "description": "Name of the skill such as Java language,\u2026" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level)." }, "IndividualDeleteEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/IndividualDeleteEventPayload" } }, "description": "The event data" }, "IndividualDeleteEventPayload": { "type": "object", "properties": { "individual": { "$ref": "#/components/schemas/Individual" } }, "description": "The event data structure" }, "IndividualCreateEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "id": { "type": "string", "description": "Identifier of the Process flow" }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/IndividualCreateEventPayload" } }, "description": "The event data" }, "IndividualCreateEventPayload": { "type": "object", "properties": { "individual": { "$ref": "#/components/schemas/Individual" } }, "description": "The event data structure" }, "IndividualAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "eventTime": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time" }, "title": { "type": "string", "description": "The title of the event." }, "eventType": { "type": "string", "description": "The type of the notification." }, "domain": { "type": "string", "description": "The domain of the event." }, "priority": { "type": "string", "description": "A priority." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "event": { "$ref": "#/components/schemas/IndividualAttributeValueChangeEventPayload" } }, "description": "The event data" }, "IndividualAttributeValueChangeEventPayload": { "type": "object", "properties": { "individual": { "$ref": "#/components/schemas/Individual" } }, "description": "The event data structure" }, "IndividualCreate": { "type": "object", "properties": { "birthDate": { "type": "string", "description": "Birth date" }, "deathDate": { "type": "string", "description": "Date of death" }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl,\u2026" }, "countryOfBirth": { "type": "string", "description": "Country where the individual was born" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "formattedName": { "type": "string", "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" }, "fullName": { "type": "string", "description": "Full name flatten (first, middle, and last names)" }, "gender": { "type": "string", "description": "Gender" }, "generation": { "type": "string", "description": "e.g.. Sr, Jr, III (the third),\u2026" }, "givenName": { "type": "string", "description": "First name of the individual" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "location": { "type": "string", "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" }, "maritalStatus": { "type": "string", "description": "Marital status (married, divorced, widow ...)" }, "middleName": { "type": "string", "description": "Middles name or initial" }, "nationality": { "type": "string", "description": "Nationality" }, "placeOfBirth": { "type": "string", "description": "Reference to the place where the individual was born" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "title": { "type": "string", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "disability": { "type": "array", "items": { "$ref": "#/components/schemas/Disability" } }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "individualIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualIdentification" } }, "languageAbility": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageAbility" } }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/OtherNameIndividual" } }, "partyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "skill": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "status": { "type": "string", "description": "Status of the individual", "enum": [ "initialized", "validated", "deceaded" ] }, "taxExemptionCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The Individual to be created" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Data containing the callback endpoint to deliver the information" }, "OrganizationUpdate": { "type": "object", "properties": { "isHeadOffice": { "type": "boolean", "description": "If value is true, the organization is the head office" }, "isLegalEntity": { "type": "boolean", "description": "If value is true, the organization is a legal entity known by a national referential." }, "name": { "type": "string", "description": "Organization name (department name for example)" }, "nameType": { "type": "string", "description": "Type of the name : Co, Inc, Ltd,\u2026" }, "organizationType": { "type": "string", "description": "Type of Organization (company, department...)" }, "tradingName": { "type": "string", "description": "Name that the organization (unit) trades under" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "existsDuring": { "$ref": "#/components/schemas/TimePeriod" }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "organizationChildRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationChildRelationship" } }, "organizationIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationIdentification" } }, "organizationParentRelationship": { "$ref": "#/components/schemas/OrganizationParentRelationship" }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/OtherNameOrganization" } }, "partyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "status": { "type": "string", "description": "Status of the organization", "enum": [ "initialized", "validated", "closed" ] }, "taxExemptionCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The Organization to be updated" }, "IndividualUpdate": { "type": "object", "properties": { "birthDate": { "type": "string", "description": "Birth date" }, "deathDate": { "type": "string", "description": "Date of death" }, "aristocraticTitle": { "type": "string", "description": "e.g. Baron, Graf, Earl,\u2026" }, "countryOfBirth": { "type": "string", "description": "Country where the individual was born" }, "familyName": { "type": "string", "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" }, "familyNamePrefix": { "type": "string", "description": "Family name prefix" }, "formattedName": { "type": "string", "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" }, "fullName": { "type": "string", "description": "Full name flatten (first, middle, and last names)" }, "gender": { "type": "string", "description": "Gender" }, "generation": { "type": "string", "description": "e.g.. Sr, Jr, III (the third),\u2026" }, "givenName": { "type": "string", "description": "First name of the individual" }, "legalName": { "type": "string", "description": "Legal name or birth name (name one has for official purposes)" }, "location": { "type": "string", "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" }, "maritalStatus": { "type": "string", "description": "Marital status (married, divorced, widow ...)" }, "middleName": { "type": "string", "description": "Middles name or initial" }, "nationality": { "type": "string", "description": "Nationality" }, "placeOfBirth": { "type": "string", "description": "Reference to the place where the individual was born" }, "preferredGivenName": { "type": "string", "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" }, "title": { "type": "string", "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "creditRating": { "type": "array", "items": { "$ref": "#/components/schemas/PartyCreditProfile" } }, "disability": { "type": "array", "items": { "$ref": "#/components/schemas/Disability" } }, "externalReference": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalReference" } }, "individualIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualIdentification" } }, "languageAbility": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageAbility" } }, "otherName": { "type": "array", "items": { "$ref": "#/components/schemas/OtherNameIndividual" } }, "partyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "skill": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "status": { "type": "string", "description": "Status of the individual", "enum": [ "initialized", "validated", "deceaded" ] }, "taxExemptionCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/TaxExemptionCertificate" } }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } }, "description": "The Individual to be updated" } }, "securitySchemes": { "security_auth": { "type": "oauth2", "scheme": "bearer", "bearerFormat": "JWT", "flows": { "authorizationCode": { "authorizationUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/auth", "tokenUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/token", "scopes": { "read": "read scope", "write": "write scope" } } } } } } }