Scheduled Transfer Settings

openapi: 3.0.3 info: title: Transfers APIs - Scheduled Transfer Settings version: v1 description: | Transfers and Transfer Settings APIs. contact: name: Platform Services - Transfers url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: http://jx-r.jhacorp.com description: Corporate Test Server security: [] components: securitySchemes: bearerAuth: description: OpenIDConnect JWT Token type: http scheme: bearer bearerFormat: JWT tags: - name: Scheduled Transfer Settings description: APIs for Scheduled Transfer settings paths: /a/api/platform/v1/{InstitutionUniversalId}/transfers/settings/scheduled-transfers: post: operationId: TransferSettings tags: - Scheduled Transfer Settings summary: API to create an scheduled transfer settings for the Account. description: API to create an scheduled transfer settings for the Account. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header description: Returned X-Request-ID schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 requestBody: description: The transfer setting to be created. content: application/json: schema: allOf: - required: - transferStartDateTime - transferRerunHours - transferRetryDays - type: object properties: transferStartDateTime: type: string format: date-time description: The date the scheduled Transfer service should start.Date will be in the ISO8601 format , for eg 2023-02-10 20:42:33.9+07:00. transferRerunHours: type: integer description: The number of hours that the Transfer Service should run throughout the day. enum: - 3 - 4 - 6 - 8 - 12 transferRetryDays: type: integer description: The number of days that a failed Transfer may retry. enum: - 0 - 1 - 2 - 3 responses: '201': description: Success headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false - required: - id - type: object properties: id: type: string format: uuid additionalProperties: false '400': description: Bad Request<hr> The server could not understand the request due to an invalid request. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: Unexpected error headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string put: operationId: PutTransferSettings tags: - Scheduled Transfer Settings summary: API to update an existing scheduled transfer settings for the Institution. description: API to update an scheduled transfer settings for the Institution. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header description: Returned X-Request-ID schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 requestBody: description: The transfer setting to be updated. content: application/json: schema: allOf: - required: - transferStartDateTime - transferRerunHours - transferRetryDays - type: object properties: transferStartDateTime: type: string format: date-time description: The date the scheduled Transfer service should start.Date will be in the ISO8601 format , for eg 2023-02-10 20:42:33.9+07:00. transferRerunHours: type: integer description: The number of hours that the Transfer Service should run throughout the day. enum: - 3 - 4 - 6 - 8 - 12 transferRetryDays: type: integer description: The number of days that a failed Transfer may retry. enum: - 0 - 1 - 2 - 3 responses: '204': description: Success headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to an invalid request. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '412': description: Precondition Failed<hr> Resources has been updated since last time it was retrieved. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: Unexpected error headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string get: operationId: GetTransferSettings tags: - Scheduled Transfer Settings summary: API to search transfers description: API to search transfers parameters: - name: Offset in: query description: The service offset provided by the API provider schema: type: string - name: Count in: query description: 'The count of records requested <br>Example: `.../resource?Count=value`' schema: type: string default: '0' - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Request-ID in: header description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header description: Returned X-Request-ID schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuditUserId in: header description: This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. schema: type: string example: UserId/UserName - name: X-AuditDeviceId in: header description: This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 responses: '200': description: Success headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - required: - transferStartDateTime - transferRerunHours - transferRetryDays - type: object properties: transferStartDateTime: type: string format: date-time description: The date the scheduled Transfer service should start.Date will be in the ISO8601 format , for eg 2023-02-10 20:42:33.9+07:00. transferRerunHours: type: integer description: The number of hours that the Transfer Service should run throughout the day. enum: - 3 - 4 - 6 - 8 - 12 transferRetryDays: type: integer description: The number of days that a failed Transfer may retry. enum: - 0 - 1 - 2 - 3 '400': description: Bad Request<hr> The server could not understand the request due to an invalid request. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '403': description: Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '404': description: Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: Unexpected error headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) may be sent from the consumer and returned by the service provider (or intermediary) regardless of the final response. required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) may be sent from the caller and returned in the response by the service providers regardless of the final response. The x-correlation-id may be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: false schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. required: false schema: type: string content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string

Please ignore this field