DLW Advantage
JHWires
>
DLW Advantage
openapi: 3.0.3
info:
title: DLW Advantage APIs
description: V1 and V2 APIs for DLW-Advantage
version: '2.0'
contact:
name: 'Digital Core @ Jack Henry and Associates, inc.'
url: 'https://www.jackhenry.com/'
email: DC-Operations@jackhenry.com
servers:
- url: 'http://jx-r.jhacorp.com'
description: Corporate Test Server
security:
- BearerAuth: []
tags:
- name: DLW Advantage Audit
description: Endpoints related to audit records
- name: DLW Advantage Messages
description: Endpoints related to messages
- name: DLW Advantage Files
description: Endpoints related to files
- name: DLW Advantage Outgoing To Fed
description: Endpoints related to outgoing messages and files to the Fed
- name: DLW Advantage Incoming From Fed
description: Endpoints related to incoming files from the Fed
paths:
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-audits':
get:
tags:
- DLW Advantage Audit
description: Dlw-Advantage `Retrieve all audit records using paging`
operationId: Dlw-Advantage-Audit-Get-All
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoAudits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-audits-search':
post:
tags:
- DLW Advantage Audit
description: >-
Dlw-Advantage `Search for audit records using filter criteria and
paging`
operationId: Dlw-Advantage-Audit-Post-Search
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
auditDateStart:
type: string
nullable: true
auditDateEnd:
type: string
nullable: true
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoAudits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-messages/{MessageId}':
get:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Retrieve message from storage by Id [IsoMessage will
always be null in response as it may contain PII]`
operationId: Dlw-Advantage-Messages-Get-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: MessageId
in: path
description: A unique identifier to establish the identity of an outgoing message
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
default: application/json
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-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:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
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) 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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-messages':
get:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Retrieve all messages from storage using paging
[IsoMessage will always be null in response as it may contain PII]`
operationId: Dlw-Advantage-Messages-Get-All
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-messages-search':
post:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Search for messages from storage using filter criteria
and paging [IsoMessage will always be null in response as it may contain
PII]`
operationId: Dlw-Advantage-Messages-Post-Search
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
processed:
type: boolean
nullable: true
amount:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files/{FileId}':
get:
tags:
- DLW Advantage Files
description: Dlw-Advantage `Retrieve file from storage by Id`
operationId: Dlw-Advantage-Files-Get-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: FileId
in: path
description: A unique identifier to establish the identity of an incoming file
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
default: application/json
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-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:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
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) 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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files':
get:
tags:
- DLW Advantage Files
description: Dlw-Advantage `Retrieve all files from storage using paging`
operationId: Dlw-Advantage-Files-Get-All
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files-search':
post:
tags:
- DLW Advantage Files
description: >-
Dlw-Advantage `Search for files from storage using filter criteria and
paging`
operationId: Dlw-Advantage-Files-Post-Search
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
status:
type: string
nullable: true
s:
type: boolean
nullable: true
note:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-messages/outgoing':
post:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `Store outgoing message provided until FI is ready to
request outgoing file`
operationId: Dlw-Advantage-Outgoing-Message-Post
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
fedMessage:
type: string
nullable: false
amount:
type: string
nullable: true
createdBy:
type: string
nullable: true
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files/outgoing':
get:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `When messageIds is not passed, it returns an outgoing
file for all outgoing messages for FI that have not already been
downloaded. When messageIds is passed, it returns an outgoing file for
outgoing messages matching the message IDs for FI that have not already
been downloaded.`
operationId: Dlw-Advantage-Outgoing-File-Get
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: messageIds
in: query
description: >-
Optional field to download outgoing file containing only messages
for the selected message IDs. If passing multiple message IDs, they
must be comma delimited and be in valid GUID format. A single
message ID can be passed as well. <br>Example:
`0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9`
schema:
type: string
example: >-
0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9
- 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-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
responses:
'200':
description: OK
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-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
Content-Length:
description: Length of the file content
schema:
type: number
default: 0
Content-Disposition:
description: >-
Used to specify if the file is returned as an attachment or
inline.
required: true
schema:
type: string
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files/outgoing/{FileId}':
get:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `Returns an outgoing file for all outgoing messages for FI
associated with FileId passed. Typically used if FI has lost outgoing
file they already downloaded.`
operationId: Dlw-Advantage-Outgoing-File-Get-By-FileId
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: FileId
in: path
description: A unique identifier to establish the identity of an incoming file
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
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-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
Content-Length:
description: Length of the file content
schema:
type: number
default: 0
Content-Disposition:
description: >-
Used to specify if the file is returned as an attachment or
inline.
required: true
schema:
type: string
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
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) 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
'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
'/a/api/dlw-advantage/v1/{InstitutionUniversalId}/iso-files/incoming':
post:
tags:
- DLW Advantage Incoming From Fed
description: >-
Dlw-Advantage `Receive incoming file sent by FI, store, and send
messages from file`
operationId: Dlw-Advantage-Incoming-File-Post
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-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: Note
in: header
description: >-
Optional field to add a note to the incoming file. Max length is 256
characters.
schema:
type: string
example: This is a note describing the file.
requestBody:
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
fileId:
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-audits':
get:
tags:
- DLW Advantage Audit
description: Dlw-Advantage `Retrieve all audit records using paging`
operationId: Dlw-Advantage-Audit-Get-All1
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoAudits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
additionalProperties: false
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Internal Server Error
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-audits-search':
post:
tags:
- DLW Advantage Audit
description: >-
Dlw-Advantage `Search for audit records using filter criteria and
paging`
operationId: Dlw-Advantage-Audit-Post-Search1
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
auditDateStart:
type: string
nullable: true
auditDateEnd:
type: string
nullable: true
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoAudits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-messages/{MessageId}':
get:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Retrieve message from storage by Id [IsoMessage will
always be null in response as it may contain PII]`
operationId: Dlw-Advantage-Messages-Get-By-Id1
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: MessageId
in: path
description: A unique identifier to establish the identity of an outgoing message
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
default: application/json
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-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:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
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) 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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-messages':
get:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Retrieve all messages from storage using paging
[IsoMessage will always be null in response as it may contain PII]`
operationId: Dlw-Advantage-Messages-Get-All1
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-messages-search':
post:
tags:
- DLW Advantage Messages
description: >-
Dlw-Advantage `Search for messages from storage using filter criteria
and paging [IsoMessage will always be null in response as it may contain
PII]`
operationId: Dlw-Advantage-Messages-Post-Search1
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
processed:
type: boolean
nullable: true
amount:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-files/{FileId}':
get:
tags:
- DLW Advantage Files
description: Dlw-Advantage `Retrieve file from storage by Id`
operationId: Dlw-Advantage-Files-Get-By-Id1
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: FileId
in: path
description: A unique identifier to establish the identity of an incoming file
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
default: application/json
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-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:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
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) 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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-files':
get:
tags:
- DLW Advantage Files
description: Dlw-Advantage `Retrieve all files from storage using paging`
operationId: Dlw-Advantage-Files-Get-All1
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-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
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/iso-files-search':
post:
tags:
- DLW Advantage Files
description: >-
Dlw-Advantage `Search for files from storage using filter criteria and
paging`
operationId: Dlw-Advantage-Files-Post-Search1
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
status:
type: string
nullable: true
s:
type: boolean
nullable: true
note:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/outgoing/iso-messages':
post:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `Store outgoing message provided until FI is ready to
request outgoing file`
operationId: Dlw-Advantage-Outgoing-Message-Post1
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-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
requestBody:
content:
application/json:
schema:
type: object
properties:
fedMessage:
type: string
nullable: false
amount:
type: string
nullable: true
createdBy:
type: string
nullable: true
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
additionalProperties: false
required: true
responses:
'204':
description: >-
No Content<hr> There is no content to send for this request, but the
headers may be useful.
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-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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/outgoing/iso-file':
get:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `When messageIds is not passed, it returns an outgoing
file for all outgoing messages for FI that have not already been
downloaded. When messageIds is passed, it returns an outgoing file for
outgoing messages matching the message IDs for FI that have not already
been downloaded.`
operationId: Dlw-Advantage-Outgoing-File-Get1
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: messageIds
in: query
description: >-
Optional field to download outgoing file containing only messages
for the selected message IDs. If passing multiple message IDs, they
must be comma delimited and be in valid GUID format. A single
message ID can be passed as well. <br>Example:
`0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9`
schema:
type: string
example: >-
0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9
- 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-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
responses:
'200':
description: OK
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-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
Content-Length:
description: Length of the file content
schema:
type: number
default: 0
Content-Disposition:
description: >-
Used to specify if the file is returned as an attachment or
inline.
required: true
schema:
type: string
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/outgoing/iso-file/{FileId}':
get:
tags:
- DLW Advantage Outgoing To Fed
description: >-
Dlw-Advantage `Returns an outgoing file for all outgoing messages for FI
associated with FileId passed. Typically used if FI has lost outgoing
file they already downloaded.`
operationId: Dlw-Advantage-Outgoing-File-Get-By-FileId1
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: FileId
in: path
description: A unique identifier to establish the identity of an incoming file
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- 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-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
responses:
'200':
description: OK
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-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
Content-Length:
description: Length of the file content
schema:
type: number
default: 0
Content-Disposition:
description: >-
Used to specify if the file is returned as an attachment or
inline.
required: true
schema:
type: string
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
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) 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
'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
'/a/api/dlw-advantage/v2/{InstitutionUniversalId}/incoming/iso-files':
post:
tags:
- DLW Advantage Incoming From Fed
description: >-
Dlw-Advantage `Receive incoming file sent by FI, store, and send
messages from file`
operationId: Dlw-Advantage-Incoming-File-Post1
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-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: Note
in: header
description: >-
Optional field to add a note to the incoming file. Max length is 256
characters.
schema:
type: string
example: This is a note describing the file.
requestBody:
content:
application/octet-stream:
schema:
type: object
properties:
file:
type: string
format: binary
nullable: false
additionalProperties: false
required: true
responses:
'200':
description: OK
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-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:
type: object
properties:
fileId:
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
'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
components:
schemas:
IsoMessageModel:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
PagingModel:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
SearchIsoMessageResponseModel:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
processed:
type: boolean
isoMessage:
type: string
nullable: true
amount:
type: number
nullable: false
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
additionalProperties: false
SearchIsoMessageRequestEntity:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
fileId:
type: string
nullable: true
uetr:
type: string
nullable: true
orgnlUetr:
type: string
nullable: true
msgDefIdr:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
processed:
type: boolean
nullable: true
amount:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
additionalProperties: false
OutgoingMessageRequestModel:
type: object
properties:
fedMessage:
type: string
nullable: false
amount:
type: string
nullable: true
createdBy:
type: string
nullable: true
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
additionalProperties: false
OutgoingFileResponseModel:
type: object
properties:
file:
type: string
format: binary
nullable: false
additionalProperties: false
IncomingFileRequestModel:
type: object
properties:
file:
type: string
format: binary
nullable: false
additionalProperties: false
IncomingFileResponseModel:
type: object
properties:
fileId:
type: string
format: uuid
additionalProperties: false
IncomingFileStatusResponseModel:
type: object
properties:
status:
type: string
nullable: false
failuresOnStore:
type: string
nullable: true
failuresOnSend:
type: string
nullable: true
wiresProcessed:
type: integer
additionalProperties: false
IsoFileModel:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
SearchIsoFileResponseModel:
type: object
properties:
isoMessages:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDate:
type: string
nullable: true
createdBy:
type: string
nullable: true
modifiedDate:
type: string
nullable: true
modifiedBy:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
status:
type: string
example: Processed
note:
type: string
nullable: true
wiresProcessed:
type: integer
reprocessed:
type: boolean
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
additionalProperties: false
SearchIsoFileRequestEntity:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
xRequestId:
type: string
nullable: true
xCorrelationId:
type: string
nullable: true
createdDateStart:
type: string
nullable: true
createdDateEnd:
type: string
nullable: true
modifiedDateStart:
type: string
nullable: true
modifiedDateEnd:
type: string
nullable: true
status:
type: string
nullable: true
s:
type: boolean
nullable: true
note:
type: string
nullable: true
failedToStore:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
failedToSend:
type: array
items:
type: string
example:
- da98c421-e211-4c67-a818-be3178dc9c39
- 47a11c91-c51a-40e6-8954-8294233df33b
additionalProperties: false
IsoAuditModel:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
SearchIsoAuditResponseModel:
type: object
properties:
isoAudits:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
outgoing:
type: boolean
auditDate:
type: string
nullable: true
additionalProperties: false
nullable: true
paging:
type: object
properties:
nextOffset:
type: string
nullable: true
results:
type: integer
format: int32
total:
type: integer
format: int64
additionalProperties: false
additionalProperties: false
SearchIsoAuditRequestEntity:
type: object
properties:
institutionUniversalId:
type: string
nullable: true
fileId:
type: string
nullable: true
outgoing:
type: boolean
nullable: true
clientId:
type: string
nullable: true
email:
type: string
nullable: true
authType:
type: string
nullable: true
user:
type: string
nullable: true
userId:
type: string
nullable: true
userIp:
type: string
nullable: true
messageInfo:
type: string
nullable: true
auditDateStart:
type: string
nullable: true
auditDateEnd:
type: string
nullable: true
additionalProperties: false
parameters:
messageIds:
name: messageIds
in: query
description: >-
Optional field to download outgoing file containing only messages for
the selected message IDs. If passing multiple message IDs, they must be
comma delimited and be in valid GUID format. A single message ID can be
passed as well. <br>Example:
`0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9`
schema:
type: string
example: >-
0d0793b7-13a4-45e1-838d-c889504fbcca,6cfa3f05-025d-451b-9e56-966c3b3d719d,89671445-fa00-425e-9e3c-9e4952a5efa9
Note:
name: Note
in: header
description: >-
Optional field to add a note to the incoming file. Max length is 256
characters.
schema:
type: string
example: This is a note describing the file.
FileId:
name: FileId
in: path
description: A unique identifier to establish the identity of an incoming file
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
MessageId:
name: MessageId
in: path
description: A unique identifier to establish the identity of an outgoing message
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
headers:
Content-Length:
description: Length of the file content
schema:
type: number
default: 0
securitySchemes:
BearerAuth:
type: http
description: OpenIDConnect JWT Token
scheme: bearer
bearerFormat: JWT
x-jh:
publishing:
type: Integration
stage: prod
isPublic: true
group: Digital Core
name: Wires
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Fri Mar 20 2026