Lobby Queue Inquiry
Lobby Queue Inquiry
Lobby Queue Inquiry is a jXchange service designed to provide a suite of services for lobby queuing.
Message Flow
In jXchange, the Lobby Queue Inquiry service uses a typical exchange of
MType messages to provide
a suite of services for lobby queuing.
Primary Request
The consumer forwards the LobbyQueInqRq_MType message to the
service provider. The message contains the following simple elements:
- ActIntent
- LobbyQueId
Primary Response
The service provider returns the LobbyQueInqRs_MType message
to the consumer. The message contains the following simple elements:
- ActIntent
- ActIntentKey
Lobby Queue Inquiry Behavior
The Lobby Queue Inquiry service behavior is as follows.
The Lobby Queue Inquiry root request message (LobbyQueInqRq_MType) requires
a valid Lobby Queue Identification element (LobbyQueId).
The Activity Intention element (ActIntent) default canonical value is ReadOnly. The canonical values Upd or Dlt require the service provider to return the Activity Intention Key element (ActIntentKey) used for subsequent modification service with the adopted concurrency model.
The Lobby Queue Inquiry root response message (LobbyQueInqRs_MType) returns
the elements related to the Lobby Queue Identification (LobbyQueId).
The Lobby Queue Identification element (LobbyQueId) can be obtained
from the Lobby Queue Search service.
Inquiry service tenets:
- The standard inquiry message tenets are applicable.
- Adhere to the tenets for fault reporting.
- Adhere to the tenets related to the correlation identifications.
- Adhere to the Concurrency model tenets.
LobbyQueInqRq_MType
LobbyQueInqRq_MType is a message MType element.
Contains:
Custom_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
- Conveys the consumer intention for a subsequent operation for the
data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- LobbyQueId
- An identifier given to entries for lobby queues.
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.
LobbyQueInqRs_MType
LobbyQueInqRs_MType is a message MType element.
Contains:
Custom_CTypeLobbyQueInqRec_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
- Conveys the consumer intention for a subsequent operation for the
data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LobbyQueInqRec_CType
LobbyQueInqRec_CType is a complex
CType element.
Contains:
Custom_CTypeLobbyQueInfoRec_CType
Simple Elements
The following simple elements are contained within this complex.
- BrDesc
- A description of the branch name. It includes the
Rstrattribute. - EventOffDesc
- The description of the code assigned to the CRM officer.
- LobbyQueId
- An identifier given to entries for lobby queues.
- LobbyQueStatDesc
- The description of the code that describes the status of the lobby queue entry.
- QueEntryTimeDt
- The time and date of an entry when captured into a queue.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
LobbyQueInfoRec_CType
LobbyQueInfoRec_CType is a complex CType element.
Simple Elements
Contains:
Addr_CTypeCustom_CTypeNamereferencesPersonName_CTypeUserDefInfoArray_AType
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- Cmnt
- Application or user remarks free-form text.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- CustType
- The customer type. Examples include business or individual.
Canonical values are:
- Bus
- Indv
- EventCatCode
- The code that conveys the category for an event.
- EventOffCode
- The code assigned to the CRM officer.
- LobbyQueStatCode
- The code that describes the status of the lobby queue entry.
- NewCustType
- Is this a new customer? Canonical values are:
- True
- False
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
Addr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the zip.
- FornAddr
- Is this a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The 2 alpha long code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Name
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Name references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
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 Soap Header Fault 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.