{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Policy Providers Query", "description": "Policy Providers Query API is part of FenX eco-system to manage providers. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/policyprovidersquery" } ], "paths": { "/api/external-adapter/suggestions": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Get suggestions by multiple field criteria from external provider.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetMultiFieldSuggestions", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MultiFieldSuggestionRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of suggestions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAdapterMultiFieldSuggestionResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/suggestion/details": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Get details for multiple field criteria suggestion from external provider.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetMultiFieldSuggestionDetails", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MultiFieldSuggestionDetailsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of details for suggestion is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiFieldSuggestionDetailsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/suggestions/{providerId}": { "get": { "tags": [ "ExternalAdapter" ], "summary": "Get suggestions from external provider.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetSuggestions", "parameters": [ { "name": "providerId", "in": "path", "description": "The ID of the provider.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldName", "in": "query", "description": "The name of the field.", "required": true, "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "description": "The value of the field.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAdapterSuggestionsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/validation": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Get validation from external provider.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetValidation", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterValidationRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Validation response returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAdapterValidationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/validation/datagroup": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Send all fields of a DataGroup to an external provider to allow validation of several fields at once,\nor by using some fields as context for the validation of another", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetDataGroupValidation", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DataGroupValidationRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Validation response returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupValidationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/validation/customtask": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Send entity id, draft id, task id and journey id to an external provider to allow any custom defined task to be triggered.\nOnce the external provider is done, return 'IsSuccess' flag true or false.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetCustomTask", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CustomTaskRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Success response returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAdapterCustomTaskResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/calculation/property-value": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Calls one or more other domain services to calculate the value a property should have\nbased on the information provided about that property within the request", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetCalculatedPropertyValue", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetCalculatedPropertyValueDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Success response returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCalculatedPropertyValueResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/external-adapter/extended-search": { "post": { "tags": [ "ExternalAdapter" ], "summary": "Perform extended search against external provider. Returns full result objects with all field values.", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetExtendedSearchResults", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExtendedSearchRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of results with field data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedSearchResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Provider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/provider": { "get": { "tags": [ "PolicyProvider" ], "summary": "Get providers", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetAllPolicyProviders", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of providers is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyProviderDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/provider/{providerId}": { "get": { "tags": [ "PolicyProvider" ], "summary": "Get provider by id", "description": "\nReturns the provider for a given id.

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetProviderById", "parameters": [ { "name": "providerId", "in": "path", "description": "PolicyApiProvider id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. PolicyProvider is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyProviderDtoServiceResponse" } } } }, "400": { "description": "Bad request. The provider has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. PolicyProvider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/provider/datagroup/{dataGroupId}": { "get": { "tags": [ "PolicyProvider" ], "summary": "Get providers by Data Group Id", "description": "

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetPolicyProvidersByDataGroupId", "parameters": [ { "name": "dataGroupId", "in": "path", "description": "Data Group Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of providers is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupProviderDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AdditionalSearchFieldsConfigDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data Key of the Data Group field used as additional search context", "nullable": true, "example": "country" } }, "additionalProperties": false, "description": "DTO which represents Additional Search Field Configuration" }, "CustomTaskRequestDto": { "required": [ "journeyId", "providerId", "taskId" ], "type": "object", "properties": { "providerId": { "minLength": 1, "type": "string", "description": "External provider id", "example": "fd5de466-a2fc-4c03-a649-35a558a0d208" }, "entityId": { "type": "string", "description": "The ID of the Entity from which this Validation check was performed", "format": "uuid", "nullable": true }, "entityDraftId": { "type": "string", "description": "The ID of the Entity Draft from which this Validation check was performed", "format": "uuid", "nullable": true }, "taskId": { "type": "string", "description": "The ID of the Task", "format": "uuid" }, "journeyId": { "type": "string", "description": "The ID of the Journey", "format": "uuid" } }, "additionalProperties": false }, "CustomTaskRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CustomTaskRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "DataGroupFieldValidationResultDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Name of the validated field", "nullable": true, "example": "postCode" }, "isValid": { "type": "boolean", "description": "Is value valid." }, "message": { "type": "string", "description": "Validation message.", "nullable": true, "example": "Postcodes for country 'Ireland' must have 7 alphanumeric characters" } }, "additionalProperties": false }, "DataGroupProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of PolicyApiProvider", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupId": { "type": "string", "description": "Id of selected data group. Required only for Type: DataGroupSearch", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "searchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/SearchFieldsConfigDto" }, "description": "List of search field configuration. Required only for Type: DataGroupSearch", "nullable": true }, "resultFieldsConfig": { "type": "array", "items": { "$ref": "#/components/schemas/ResultFieldsConfigDto" }, "description": "List of result field configuration. Required only for Type: DataGroupSearch", "nullable": true }, "additionalSearchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalSearchFieldsConfigDto" }, "description": "List of data group fields sent as additional search context. Optional for Type: DataGroupSearch", "nullable": true } }, "additionalProperties": false }, "DataGroupProviderDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupProviderDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DataGroupValidationFieldDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name", "nullable": true, "example": "country" }, "fieldValue": { "type": "string", "description": "Field value", "nullable": true, "example": "Ireland" } }, "additionalProperties": false, "description": "Represents field object with name and value" }, "DataGroupValidationRequestDto": { "required": [ "fields", "providerId" ], "type": "object", "properties": { "providerId": { "minLength": 1, "type": "string", "description": "External provider id", "example": "fd5de466-a2fc-4c03-a649-35a558a0d208" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupValidationFieldDto" }, "description": "All fields of the Data Group" }, "entityId": { "type": "string", "description": "The ID of the Entity from which this Validation check was performed", "format": "uuid", "nullable": true }, "entityDraftId": { "type": "string", "description": "The ID of the Entity Draft from which this Validation check was performed", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request fields for external provider multi field search." }, "DataGroupValidationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DataGroupValidationRequestDto" } ], "description": "Request fields for external provider multi field search.", "nullable": true } }, "additionalProperties": false }, "DataGroupValidationResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" }, "validationResults": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupFieldValidationResultDto" }, "description": "Collection of validation responses for fields in the datagroup.", "nullable": true } }, "additionalProperties": false, "description": "Response fields for external provider multi field validation." }, "DataGroupValidationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DataGroupValidationResponseDto" } ], "description": "Response fields for external provider multi field validation.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtendedSearchFieldDto": { "required": [ "fieldName", "fieldValue" ], "type": "object", "properties": { "fieldName": { "minLength": 1, "type": "string", "description": "Field name", "example": "country" }, "fieldValue": { "minLength": 1, "type": "string", "description": "Field value", "example": "Ireland" } }, "additionalProperties": false, "description": "Represents a field with name and value for extended search." }, "ExtendedSearchRequestDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "External provider id", "nullable": true, "example": "fd5de466-a2fc-4c03-a649-35a558a0d208" }, "searchFields": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedSearchFieldDto" }, "description": "List of fields with values", "nullable": true } }, "additionalProperties": false, "description": "Request fields for external provider extended search." }, "ExtendedSearchRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtendedSearchRequestDto" } ], "description": "Request fields for external provider extended search.", "nullable": true } }, "additionalProperties": false }, "ExtendedSearchResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedSearchResultItemDto" }, "description": "List of results with full field data.", "nullable": true } }, "additionalProperties": false, "description": "Response from external provider extended search." }, "ExtendedSearchResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtendedSearchResponseDto" } ], "description": "Response from external provider extended search.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtendedSearchResultItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of a result from external provider.", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418a" }, "displayValue": { "type": "string", "description": "Display value, nicely formatted", "nullable": true, "example": "Ireland, Dublin, 123 Street" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedSearchFieldDto" }, "description": "Full list of field name/value pairs for this result.", "nullable": true } }, "additionalProperties": false, "description": "A single result from extended search containing full field data." }, "ExternalAdapterCustomTaskResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Is value valid." }, "message": { "type": "string", "description": "Validation message.", "nullable": true, "example": "Field must contain digits." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" } }, "additionalProperties": false, "description": "Response DTO representing custom task" }, "ExternalAdapterCustomTaskResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterCustomTaskResponse" } ], "description": "Response DTO representing custom task", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExternalAdapterMultiFieldSuggestionResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" }, "searchSuggestions": { "type": "array", "items": { "$ref": "#/components/schemas/MultiFieldSuggestionResponseItemDto" }, "description": "List of suggestions", "nullable": true } }, "additionalProperties": false, "description": "Response fields for external provider multi field search search." }, "ExternalAdapterMultiFieldSuggestionResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterMultiFieldSuggestionResponseDto" } ], "description": "Response fields for external provider multi field search search.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExternalAdapterSuggestionsResponseDto": { "type": "object", "properties": { "searchSuggestions": { "type": "array", "items": { "$ref": "#/components/schemas/SuggestionDto" }, "description": "Search suggestions from providers.", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" } }, "additionalProperties": false, "description": "Response DTO representing search suggestions data" }, "ExternalAdapterSuggestionsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterSuggestionsResponseDto" } ], "description": "Response DTO representing search suggestions data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExternalAdapterValidationRequestDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Provider Id", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "fieldName": { "type": "string", "description": "Field Name.", "nullable": true, "example": "Street" }, "fieldValue": { "type": "string", "description": "Field value.", "nullable": true, "example": "Abbey" }, "entityId": { "type": "string", "description": "Entity Id.", "format": "uuid", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "entityDraftId": { "type": "string", "description": "Journey Id.", "format": "uuid", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" } }, "additionalProperties": false, "description": "Response DTO representing external provider validation request" }, "ExternalAdapterValidationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterValidationRequestDto" } ], "description": "Response DTO representing external provider validation request", "nullable": true } }, "additionalProperties": false }, "ExternalAdapterValidationResponseDto": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "Is value valid." }, "message": { "type": "string", "description": "Validation message.", "nullable": true, "example": "Field must contain digits." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" } }, "additionalProperties": false, "description": "Response DTO representing search suggestions data" }, "ExternalAdapterValidationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalAdapterValidationResponseDto" } ], "description": "Response DTO representing search suggestions data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetCalculatedPropertyValueDto": { "type": "object", "properties": { "calculatorName": { "type": "string", "description": "The name of the calculator service which will be used to acquire the calculated value", "nullable": true }, "propertyName": { "type": "string", "description": "Name of the property to be calculated", "nullable": true, "example": "borrowerName" }, "calculationProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional properties which provide the information needed to calculate the value of the main property.", "nullable": true } }, "additionalProperties": false, "description": "Request DTO borrower data" }, "GetCalculatedPropertyValueDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetCalculatedPropertyValueDto" } ], "description": "Request DTO borrower data", "nullable": true } }, "additionalProperties": false }, "GetCalculatedPropertyValueResponseDto": { "type": "object", "properties": { "calculatedValue": { "type": "string", "description": "Calculated Property Value", "nullable": true, "example": "Customer Individual and Customer Company" } }, "additionalProperties": false, "description": "Request DTO borrower data" }, "GetCalculatedPropertyValueResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetCalculatedPropertyValueResponseDto" } ], "description": "Request DTO borrower data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetCalculatedPropertyValueResultWithErrors": { "allOf": [ { "$ref": "#/components/schemas/GetCalculatedPropertyValueResponseDto" }, { "type": "object", "properties": { "validationErrors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ], "description": "Request DTO borrower data" }, "MultiFieldSuggestionDetailsRequestDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "External provider id", "nullable": true, "example": "fd5de466-a2fc-4c03-a649-35a558a0d208" }, "suggestionId": { "type": "string", "description": "Suggestion id from external provider", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418a" } }, "additionalProperties": false, "description": "Request details for external provider of multi field search suggestion." }, "MultiFieldSuggestionDetailsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MultiFieldSuggestionDetailsRequestDto" } ], "description": "Request details for external provider of multi field search suggestion.", "nullable": true } }, "additionalProperties": false }, "MultiFieldSuggestionDetailsResponseDto": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ], "description": "Status of response from provider.", "example": "Ok" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/MultiFieldSuggestionFieldDto" }, "description": "List of returned values with associated filed names", "nullable": true } }, "additionalProperties": false, "description": "Result details suggestion object" }, "MultiFieldSuggestionDetailsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MultiFieldSuggestionDetailsResponseDto" } ], "description": "Result details suggestion object", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MultiFieldSuggestionFieldDto": { "required": [ "fieldName", "fieldValue" ], "type": "object", "properties": { "fieldName": { "minLength": 1, "type": "string", "description": "Field name", "example": "country" }, "fieldValue": { "minLength": 1, "type": "string", "description": "Field value", "example": "Ireland" } }, "additionalProperties": false, "description": "Represents field object with name and value" }, "MultiFieldSuggestionRequestDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "External provider id", "nullable": true, "example": "fd5de466-a2fc-4c03-a649-35a558a0d208" }, "searchFields": { "type": "array", "items": { "$ref": "#/components/schemas/MultiFieldSuggestionFieldDto" }, "description": "List of fields with values", "nullable": true } }, "additionalProperties": false, "description": "Request fields for external provider multi field search." }, "MultiFieldSuggestionRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MultiFieldSuggestionRequestDto" } ], "description": "Request fields for external provider multi field search.", "nullable": true } }, "additionalProperties": false }, "MultiFieldSuggestionResponseItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of a suggestion from external provider.", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418a" }, "displayValue": { "type": "string", "description": "Display value, nicely formatted", "nullable": true, "example": "Ireland, Dublin, 123 Street" } }, "additionalProperties": false, "description": "Result suggestion object" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PolicyProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of PolicyApiProvider", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Name of Policy Api Provider", "nullable": true, "example": "Policy_api_provider_name" }, "serviceUrl": { "type": "string", "description": "Url of Policy Api Provider service", "nullable": true, "example": "https://TestProviderService.com" }, "type": { "type": "string", "description": "Type of Policy Api Provider\nAvailable options are: Search, Validation", "nullable": true, "example": "Search" }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "dataGroupId": { "type": "string", "description": "Id of selected data group. Required only for Type: DataGroupSearch", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "searchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/SearchFieldsConfigDto" }, "description": "List of search field configuration. Required only for Type: DataGroupSearch", "nullable": true }, "resultFieldsConfig": { "type": "array", "items": { "$ref": "#/components/schemas/ResultFieldsConfigDto" }, "description": "List of result field configuration. Required only for Type: DataGroupSearch", "nullable": true }, "additionalSearchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalSearchFieldsConfigDto" }, "description": "List of data group fields sent as additional search context. Optional for Type: DataGroupSearch", "nullable": true }, "detailsUrl": { "type": "string", "description": "Url of Policy Api Provider details service", "nullable": true, "example": "https://TestProviderService.com" }, "callIntegrationFlow": { "type": "boolean", "description": "The flag which indicates if Integration Flow should be called instead of ServiceUrl", "example": true }, "flowKey": { "type": "string", "description": "Integration Flow Key", "nullable": true, "example": "validationFlow" }, "detailsFlowKey": { "type": "string", "description": "Integration Flow Key of getting details for selected option", "nullable": true, "example": "validationFlowDetails" } }, "additionalProperties": false, "description": "Response DTO representing requirement set data" }, "PolicyProviderDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyProviderDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PolicyProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderDto" } ], "description": "Response DTO representing requirement set data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ResponseStatus": { "enum": [ "Ok", "Error" ], "type": "string", "description": "ResponseStatus class with possible statuses" }, "ResultFieldsConfigDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data Key of Data Group field", "nullable": true, "example": "Address_Line1" } }, "additionalProperties": false, "description": "DTO which represents Result Field Configuration" }, "SearchFieldsConfigDto": { "type": "object", "properties": { "label": { "type": "string", "description": "Field label", "nullable": true, "example": "Full Address" }, "name": { "type": "string", "description": "Field name", "nullable": true, "example": "FullAddress" } }, "additionalProperties": false, "description": "DTO which represents Search Field Configuration" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SuggestionDto": { "type": "object", "properties": { "value": { "type": "string", "description": "Suggested value. Depends on provider it can be for example street name.", "nullable": true, "example": "Abbey Road" }, "order": { "type": "integer", "description": "Suggested order value. Determines the order from best to worst match.", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Single search suggestion" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }