EDPP Person Product Modification
EDPP Person Product Modification
EDPP Person Product Modification is a jXchange service designed to allow users to modify data on a requesting customer.
Message Flow
In jXchange, the EDPP Person Product Modification service uses a typical
exchange of MType messages
to modify data on a requesting customer.
Primary Request
The consumer forwards the
EDPPPersonProdModRq_MType message to
the service provider. The message contains the following simple elements:
- CustID
- Dlt
- ProdCode
- ProdSubCode
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CType
Primary Response
The service provider returns the
EDPPPersonProdModRs_MType message to
the consumer.
The message contains the following complex element:
Custom_CType
The message contains the following array element:
DictRsArray_AType
EDPP Person Product Modification Behavior
The EDPP Person Product Modification service behavior is as follows.
The EDPP Person Product Modification root request
(EDPPPersonProdModRq_MType) requires the Product Code
(ProdCode), Customer Identifier (CustId), and
Delete (Dlt).
The EDPP Person Product Modification root request
(EDPPPersonProdModRq_MType) optionally includes the Product Sub-Code
(ProdSubCode). The EDPP Person Product Modification root response
(EDPPPersonProdModRs_MType) returns the Dictionary Response Array
(DictRsArray_AType), which contains the Dictionary Response Information
Record (DictRsInfoRec_CType). This element contains the Dictionary Data Name
(DictDataName), Dictionary Data Value
(DictDataVal), Dictionary Data State
(DictDataState), and Dictionary Data Remark
(DictDataRmk).
The provider conveys to the consumer the dictionary data names that were deleted, along with the values, and which were retained.
Products reserve the right to only delete allowable variables.
The standard Modification message tenets are applicable.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
Adhere to the tenets related to the JHA Null Attribute.
Adhere to the tenets related to the concurrency models.
EDPPPersonProdModRq_MType
EDPPPersonProdModRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- Dlt
- The delete element. Canonical values are:
- false
- true
- ProdCode
- The code that identifies a product type of account within an
application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdCode is a hybrid open enumeration.
- ProdSubCode
- The code that identifies a product type of account within an
application. Canonical values are:
- jha-4sight
- jha-argokeys
- jha-cif2020
- jha-coredirector
- jha-imagecenter
- jha-silverlake
- jha-synapsys
ProdSubCode is a hybrid open enumeration.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
EDPPPersonProdModRs_MType
EDPPPersonProdModRs_MType is a message
MType element.
Contains:
Custom_CTypeDictRsArray_CTypeMsgRsHdr_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DictRsArray_AType
DictRsArray_AType is an array AType element. This is an array of
EDPP dictionary entries.
Contains:
DictRsInfoRec_CType
DictRsInfoRec_CType
DictRsInfoRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- DictDataName
- The dictionary entry name.
- DictDataRmk
- Application or user remarks free-form text.
- DictDataState
- The state of the request for the data dictionary. Canonical values
are:
- Dlt
- Retain
- DictDataVal
- The value of the dictionary entry name.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array
AType element. This is an array of messages that can be
returned in a response.
Contains:
MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.