Exception Item Processing Settings API

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Exception Item Processing Settings API description: Digital Core Exception Item Processing API - Management of a Financial Institution's Exception Item Processing contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Exception Item Processing Settings API description: Exception Item Processing Settings OpenAPI Definitions paths: /a/api/eip/v1/{InstitutionUniversalId}/settings: post: tags: - Exception Item Processing Settings API summary: API to create the Exception Item Processing setting Record. description: Create Exception Item Processing Setting operationId: CreateEIPSetting parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The eip setting resource to be created. content: application/json: schema: required: - settingName - settingType - settingCategory - settingDetails type: object properties: settingName: type: string description: This atrribute Identifies the name of the setting. nullable: false settingType: type: string description: This attribute Identifies type of the setting. enum: - UserSetting - InstitutionSetting nullable: false settingCategory: type: string description: The SettingCategory is to organize and group setting options based on their functional or purpose. enum: - SavedSearches nullable: false settingDetails: type: string format: object description: This attribute will fetch attributes from EIP List API call and subject to change with change in EIP List API attributes. nullable: false responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string format: UUID nullable: false settingName: type: string description: This atrribute Identifies the name of the setting. createdDateTime: type: string format: date-time nullable: false 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 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: description: Search Exception Item Processing Setting operationId: SearchEIPSetting tags: - Exception Item Processing Settings API summary: API to Get all the Exception Item Processing setting Service for a perticular Settings Type 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: SettingType in: query description: The Setting Type identifies if the saved search is private to the user who created or public to all users with in Financial Institution schema: type: string enum: - UserSetting - InstitutionSetting - name: SettingCategory in: query description: The SettingCategory is to organize and group setting options based on their functional or purpose. schema: type: string enum: - SavedSearches - name: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: UUID nullable: false settingName: type: string description: This atrribute Identifies the name of the setting. settingType: type: string description: This attribute Identifies type of the setting. enum: - UserSetting - InstitutionSetting settingDetails: type: string format: object description: This attribute will fetch attributes from EIP List API call and subject to change with change in EIP List API attributes. settingCategory: type: string description: The SettingCategory is to organize and group setting options based on their functional or purpose. enum: - SavedSearches createdDateTime: type: string format: date-time nullable: false lastChangedDateTime: type: string format: date-time nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/settings/{Id}: put: description: Update Exception Item Processing Setting operationId: UpdateEIPSetting tags: - Exception Item Processing Settings API summary: API to update the Exception Item Processing setting by Id 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: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: description: The eip setting resource to be updated. content: application/json: schema: type: object properties: settingName: type: string description: This atrribute Identifies the name of the setting. settingType: type: string description: This attribute Identifies type of the setting. enum: - UserSetting - InstitutionSetting settingCategory: type: string description: The SettingCategory is to organize and group setting options based on their functional or purpose. enum: - SavedSearches settingDetails: type: string format: object description: This attribute will fetch attributes from EIP List API call and subject to change with change in EIP List API attributes. responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: UUID nullable: false settingName: type: string description: This atrribute Identifies the name of the setting. settingType: type: string description: This attribute Identifies type of the setting. enum: - UserSetting - InstitutionSetting settingDetails: type: string format: object description: This attribute will fetch attributes from EIP List API call and subject to change with change in EIP List API attributes. settingCategory: type: string description: The SettingCategory is to organize and group setting options based on their functional or purpose. enum: - SavedSearches createdDateTime: type: string format: date-time nullable: false lastChangedDateTime: type: string format: date-time nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: description: Delete Exception Item Processing Setting operationId: DeleteEIPSetting tags: - Exception Item Processing Settings API summary: API to Delete the Exception Item Processing setting by Id 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: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: description: Get an Exception Item Processing Setting by Id operationId: GetEIPSetting tags: - Exception Item Processing Settings API summary: API to Get the Exception Item Processing setting by Id 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: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: UUID nullable: false settingName: type: string description: This atrribute Identifies the name of the setting. settingType: type: string description: This attribute Identifies type of the setting. enum: - UserSetting - InstitutionSetting settingDetails: type: string format: object description: This attribute will fetch attributes from EIP List API call and subject to change with change in EIP List API attributes. settingCategory: type: string description: The SettingCategory is to organize and group setting options based on their functional or purpose. enum: - SavedSearches createdDateTime: type: string format: date-time nullable: false lastChangedDateTime: type: string format: date-time nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field