Purpose
Back To HomeThe Client Integration Guide serves as a comprehensive resource for facilitating the seamless integration of MAX with client applications through the MAX API. It equips users with essential information necessary for the successful receipt of orders and the submission of products upon order completion.
This document is authored, updated, and disseminated by Avanze Tech Labs Inc. (“ATL”) with the primary objective of conveying implementation requisites to our valued clients and MAX. ATL stands behind the accuracy and relevance of the content provided within this Client Implementation Guide, ensuring alignment with our integration standards.
Client ID
The following Client IDs are designated for use when sending order requests and handling other respective events. It is important for clients to ensure that all Client IDs are correctly configured within their respective environments.
Environment | Client ID | Client Name |
---|---|---|
UAT | ATLMAXUAT | Will be provided during UAT |
PROD | ATLMAXPROD | Will be provided during PROD |
Products
Through the MAX API, clients have the capability to place orders for a variety of products. The product listing provided below contains all potential products that AvanzeAPI can deliver through the client platform. However, it is essential for clients to reference their individual subscription agreements with ATL and configure the products relevant to their specific implementation.
Product Code | Product Name/ Type |
---|---|
1 | Lien Release |
2 | Assignment |
3 | Curative |
4 | First Legal Product |
5 | Refinance Attorney Opinion Letter |
6 | Finance Purchase Attorney Opinion Letter |
7 | Cash Purchase Attorney Opinion Letter |
Connectivity Detail
HTTPs Post Method
When connecting to an API using the HTTPS POST method, you're utilizing a secure communication protocol (HTTPS) to send data to the API endpoint. Here's a detailed description:
1. Secure Communication: HTTPS ensures secure communication over the internet by encrypting data during transmission, preventing any unauthorized access during transit.
2. Data Transmission: With the POST method, you're sending data from the client application to the API endpoint. This data could be in various formats such as JSON, XML, or form data, tailored to the API's requirements.
3. Endpoint Interaction: The API endpoint is a specific URL provided by the API service that defines where the POST request should be sent. This endpoint typically represents a particular functionality or resource provided by the API.
4. Payload: Enclosed within the request body, the payload that contains essential information important for the API to execute the desired operation. This may involve creating a new resource, updating existing data, or retrieving information.
5. Authentication: Accessing the API endpoint securely mandates authentication of the requests. This involves providing credentials, such as an API key or access token, within the request headers to substantiate the identity and authorization.
6. Response Handling: Upon sending the POST request to the API endpoint, a response is returned from the server. This response contains various information, including success or error status codes, along with any data generated by the API in response to the query.
7. Error Handling Effective error management is important when interfacing with APIs. When the API encounters difficulties processing requests, it will typically return an appropriate error status code and, potentially, additional error details in the response body. As a result, the client application must proficiently handle these scenarios and respond accordingly.
In summary, employing the HTTPS POST method to interface with an API facilitates secure and dependable communication between the client application and the API service. This capability empowers applications to seamlessly interact with and harness the full functionality offered by the API.
Integration clients may also choose to develop a HTTPs Receiver of their own, in which they would receive via HTTPs Post. Following URL will be used by integration to post inbound events to AvanzeAPI application which will route the events to MAX application.
Environment | URL |
---|---|
UAT | https://avanzeapi.com/{modulename}/{orgcode} |
PROD | https://avanzeapi.com/{modulename}/{orgcode} |
Authorization through POST Parameters
Password = [PASSWORD]
Username and password value used to authenticate incoming request. These values are defined in CLIENT API application for each integrator.
Authorization through Header
Instead of sending credentials in plain text through post parameters, an authenticated request includes the Authorization Header Variable. If this header is not included, the request is anonymous and may not succeed against API services.
To authenticate a request, you must encode the combined username and password in the request.
The format for the Authorization header is as follows:
Authorization: Basic [Encoded-Base64-String]
Constructing the Basic Authentication
Constructing Basic Authentication through headers involves encoding the username and password in a specific format and including them in the HTTPs request headers. Here's how you can do it:
Encode Credentials: Combine the username and password with a colon (:) separator, then base64 encodes the resulting string. The format is username:password.
Set the Authorization header of the HTTP request to the value "Basic” followed by the base64 encoded credentials.
The final header value should look like "Basic {base64_encoded_credentials}".
Example Request: ## Header: Method: POST Request URL: https://stage.avanzeapi.com/{modulename}/{orgcode} Authorization: Basic {base64_encoded_credentials} Content Type: application/xml or application/json ## Body:
Authorization through POST Parameters
Token-based authentication is a protocol which allows users to verify their identity, and in return receive a unique access token. During the life of the token, users then access the website or app that the token has been issued for, rather than having to re-enter credentials each time they go back to the same webpage, app, or any resource protected with that same token.
Auth tokens work like a stamped ticket. The user retains access as long as the token remains valid. Once the user logs out or quits an app, the token is invalidated.
Token-based authentication is different from traditional password-based or server-based authentication techniques. Tokens offer a second layer of security, and administrators have detailed control over each action and transaction.
Token Authentication in 4 Easy Steps:
Use a token-based authentication system, and visitors will verify credentials just once. In return, they'll get a token that allows access for a time period you define.
The process works like this:
Request: The person asks for access to a server or protected resource. That could involve a login with a password, or it could involve some other process you specify. Verification: The server determines that the person should have access. That could involve checking the password against the username, or it could involve another process you specify. Tokens: The server communicates with the authentication device, like a ring, key, phone, or similar device. After verification, the server issues a token and passes it to the user. Storage: The token sits within the user's browser while work continues.
If the user attempts to visit a different part of the server, the token communicates with the server again. Access is granted or denied based on the token.
Administrators set limits on tokens. You could allow a one-use token that is immediately destroyed when the person logs out. Or you could set the token to self-destruct at the end of a specified time period.
A JSON Web Token consists of three parts: Header, Payload and Signature. The header and payload are Base64 encoded, then concatenated by a period, finally the result is algorithmically signed producing a token in the form of header.claims.signature. The header consists of metadata including the type of token and the hashing algorithm used to sign the token. The payload contains the claims data that the token is encoding. The final result looks like:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXNzYWdlIjoiSldUIFJ1bGVzISIsImlhdCI6MTQ1OTQ0ODExOSwiZXhwIjoxNDU5NDU0NTE5fQ.-yIVBD5b73C75osbmwwshQNRC7frWUYrqaTjTpza2y4
Authorization through POST Parameters
client_id | [USER] |
client_secret | [PASSWORD] |
scope | Integrations |
The Integration sends a POST request with following body parameters to the authorization server:
The authorization server will respond with a JSON object containing the following properties:
The access token is active for 15 minutes, up to a maximum of 120 minutes (2 hours). To avoid expiration, the access token must be used (by calling an API) at least once every 15 minutes. Active minutes and expiration duration are configurable based on the Integration requirements.
Event Code | Event Name | Type | Event Definition |
---|---|---|---|
AT11 | PlaceOrder | INBOUND | Client sends this event to initiate an order request to MAX. |
AT12 | AcceptOrder | OUTBOUND | MAX sends this event to CLIENT to inform that MAX accepts the order request. |
AT13 | RejectOrder | OUTBOUND | MAX sends this event to CLIENT to inform that the MAX does not accept the order request. |
AT14 | ProductDelivery | OUTBOUND | MAX sends this event to Client with the order documents and product data. |
AT15 | AddNotes | BOTH | Client & MAX send this event to provide a note on an order request. |
AT21 | HoldOrder | BOTH | CLIENT and/or MAX send this event to place the order request on hold. |
AT22 | CancelOrder | BOTH | CLIENT and/or MAX send this event to cancel the order request. |
AT23 | ResumeOrder | BOTH | CLIENT or MAX sends this event to resume a service order request that has been cancelled or put on hold. |
AT25 | AddDocument | BOTH | CLIENT or MAX sends this event to attach documents to the order. |
AT30 | GetStatus | INBOUND | The Client sends this event to the MAX to get the current status of the order |
AT31 | OrderStatus | OUTBOUND | The MAX sends this event to the Client to notify the current status of the order. |
AT35 | UpdateOrderStatus | INBOUND | CLIENT and/or MAX send this event to update the order status and documents data |
AT45 | ClientFeedback | INBOUND | Client sends this event to the MAX to raise the exception |
AT50 | OrderComplete | OUTBOUND | The CLIENT sends this event to notify MAX that the order request is completed. |
*Mandatory
Inbound - Events receiving from client.
Outbound - Events sending from MAX.
Workflow Diagram:
Client has documented the workflow process they require of their MAX which includes the ordering and completion of products
A typical standard workflow process that clients commonly demand from their MAX instance encompasses the entire product ordering and order completion process.
Order Placement • CLIENT will create the Order Requests (CLIENT API Event AT11). CLIENT API will route the orders to MAX.
Confirmation of the orders • MAX will confirm the request (CLIENT API Event AT12) for the order. • If MAX does not accept the order, MAX will decline the order by sending Order Not Accepted by MAX (CLIENT API Event AT13) on the order.
Order Process • The MAX and/or CLIENT may send the documents to the order by the event (CLIENTAPI Event AT25) event. • When the order is complete, MAX will upload the documents using Document Delivered by MAX with product data (CLIENT API Event AT14).
Quality Check • After receiving the (CLIENT API Event AT14), CLIENT with do quality check for every order. If Quality check is passed, then CLIENT will send (CLIENT API Event AT50) to MAX. If QC fails, then Client sends AT45 (CLIENT API Event AT45) to MAX Which will move the order into Client feedback queue and then after correction the MAX will send the (CLIENT API Event AT14) back to CLIENT.
Completion of Order • CLIENT will send Order Completed (CLIENT API Event AT50) to the MAX to indicate the order is completed.
General Use Events • MAX should post any notes or events to CLIENT by sending Notes (CLIENT API Event AT15) on the applicable order. Notes (CLIENT API Event AT15) will also be utilized by the CLIENT on the applicable order to relay information to CLIENT. • The MAX and/or CLIENT may communicate that the order is on hold by sending Order On-Hold (CLIENTAPI Event AT21) event. The Order Resume (CLIENTAPI Event AT23) is sent to resume an order that has been put on hold (CLIENT API Event AT21). • The Client sends this event to the MAX to get the status of the order (CLIENT API Event AT30) event. • The MAX or Client sends this event to notify the order status and documents data of the order (CLIENT API Event AT35) event. • The MAX sends this event to the CLIENT to notify the status of the order (CLIENT API Event AT31) event. • If either the CLIENT or MAX needs to cancel the order at any time, Order Cancelled (CLIENT API Event AT22) should be sent on the order to be cancelled.
AT11 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT11 |
EventName | O | Name of the event. Eg: PlaceOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
Comments | O | Comments |
LoanNumber | R | Loan Number |
ProductCode | R | ProductCode is mentioned in Product Section |
ProductName | O | ProductName is mentioned in Product Section |
PaidInFullDate | R | Date of loan amount paid (yyyy-mm-dd) |
OriginalLoanDate | R | Actual loan date (yyyy-mm-dd) |
OriginalLoanBalance | R | Actual loan amount pending |
BorrowerPaidFee | R | Borrower paid amount |
CustodianOfRecord | O | Custodian Of Record |
AssignmentDateTime | R | Assignment Date Time (yyyy-mm-dd) |
BorrowerName | R | Borrower name |
BorrowerEmail | R | Borrower email id |
CoBorrowerName | O | Co-Borrower name |
CoBorrowerEmail | O | Co-Borrower email id |
Transaction > Property | ||
Address1 | R | Property address |
Address2 | R | Property address |
State | R | Property state code |
County | R | Property county |
City | R | Property city |
Zipcode | R | Property zipcode |
Transaction > DocumentList | ||
Count | R | No of documents count |
Transaction > DocumentList > Document | ||
FileName | R | File Name |
FileType | R | Document type. Eg: PDF |
If FileSource is Base 64 | ||
EncodingType | R | Encoded format. Eg: Base64 |
Content | R | Encoded content of the file |
If FileSource is S3/SFTP/LINK | ||
File Path | R | File path of the attachment |
AT12 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT12 |
EventName | O | Name of the event. Eg: AcceptOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT13 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT13 |
EventName | O | Name of the event. Eg: RejectOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
Comments | O | Comments |
AT14 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT14 |
EventName | O | Name of the event. Eg: ProductDelivery |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the provider |
Comments | O | Comments |
Transaction > ProductData | ||
PropertyAddress1 | R | Property address |
PropertyAddress2 | R | Property address |
PropertyCityName | R | Property located city |
PropertyStateName | R | State code |
PropertyCountyName | R | County |
PropertyZipCode | R | Zipcode |
BorrowerNameFirst | R | Borrower first name |
BorrowerNameMiddle | R | Borrower middle name |
BorrowerNameLast | R | Borrower last name |
NoteDate | R | Date (yyyy-mm-dd) |
LoanAmount | R | Loan amount |
MaturityDate | R | Date (yyyy-mm-dd) |
MERSDescription | R | MERS Description |
ReturnToOrg | R | Return Organization |
ReturnAddress1 | R | Address line 1 |
ReturnAddress2 | R | Address line 2 |
ReturnCityName | R | City |
ReturnStateCode | R | State code |
ReturnZipCode | R | Zip code |
TaxID | R | Tax ID |
MERSPhoneNo | R | Phone |
AssignorName | R | Assignor name |
MortgageDated | R | Mortgage Date |
DocumentNumber | R | Document Number |
Trustee | R | Trustee |
MIN | R | MIN number |
Lender | R | Lender |
LenderName | R | Lender Name |
LenderAddress | R | Lender Address |
RecordedDate | R | Recorded Date |
LegalDescription | R | Legal description |
NotaryDateOfExpiration | R | Date |
Notary | R | Notary Name |
NotaryAck | R | Notary ACK Description |
NotaryCountyName | R | County |
SignorTitle | R | Signor Title Information |
Signor | R | Signor Name |
EndorserName | R | Endorser Name |
AssignorAddress1 | R | Assignor Address1 |
AssignorAddress2 | R | Assignor Address2 |
AssignorCityName | R | Assignor city |
AssignorStateName | R | Assignor state |
AssignorZipCode | R | Assignor Zipcode |
AssigneeName | R | Assignee Name |
AssigneeAddress1 | R | Assignee Address1 |
AssigneeAddress2 | R | Assignee Address2 |
AssigneeCityName | R | Assignee city |
AssigneeStateName | R | Assignee state |
AssigneeZipCode | R | Assignee Zipcode |
BorrowerName | R | Borrower Name |
Book | R | Book |
Page | R | Page |
NotaryStateName | R | State |
Witness1 | R | Witness Name1 |
PrintDate | R | Print Date (yyyy-mm-dd) |
DeedOfTrustDated | R | Deed of Trust Dated (yyyy-mm-dd) |
Witness2 | R | Witness Name2 |
SecurityDeedDate | R | Security Deed Date (yyyy-mm-dd) |
LoanNumber | R | Loan number |
SIS | R | SIS |
Mortgagor | R | Mortgagor Name |
Mortgagee | R | Mortgagee Name |
Instrument | R | Instrument |
DatedDate | R | Dated Date (yyyy-mm-dd) |
ExecutedDate | R | Executed Date (yyyy-mm-dd) |
OwnerName | R | Owner name |
Designation | R | Designation |
ReturnPhoneNo | R | Phone number |
MERSMailingAddress | R | MERS Mailing Address |
PreparedBy | R | The person who prepared the document |
PreparedByOrg | R | The organization who prepared the document |
PreparedByAddress1 | R | Address line1 |
PreparedByAddress2 | R | Address line2 |
PreparedByCityName | R | City name |
PreparedByStateCode | R | State |
PreparedZipCode | R | Zipcode |
PreparedByPhoneNo | R | Phone number |
Transaction > DocumentList | ||
Count | R | No. of documents attached |
Transaction > DocumentList > Document | ||
FileName | R | File name |
FileType | R | Document type. Eg: PDF |
If FileSource is Base 64 | ||
EncodingType | R | Encoded format. Eg: Base64 |
Content | R | Encoded content of the file |
If FileSource is S3/SFTP/LINK | ||
File Path | R | File path of the attachment |
AT15 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT15 |
EventName | O | Name of the event. Eg: AddNotes |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT21 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT21 |
EventName | O | Name of the event. Eg: HoldOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT22 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT22 |
EventName | O | Name of the event. Eg: CancelOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT23 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT23 |
EventName | O | Name of the event. Eg: ResumeOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT30 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT30 |
EventName | O | Name of the event. Eg: GetStatus |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
AT31 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT31 |
EventName | O | Name of the event. Eg: OrderStatus |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
OrderStatus | O | Current status of the order |
Comments | O | Comments |
AT45 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT11 |
EventName | O | Name of the event. Eg: PlaceOrder |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | O | OrderNumber of MAX Application |
Comments | O | Comments |
LoanNumber | R | Loan Number |
ProductCode | R | ProductCode is mentioned in Product Section |
ProductName | O | ProductName is mentioned in Product Section |
PaidInFullDate | R | Date of loan amount paid (yyyy-mm-dd) |
OriginalLoanDate | R | Actual loan date (yyyy-mm-dd) |
OriginalLoanBalance | R | Actual loan amount pending |
BorrowerPaidFee | R | Borrower paid amount |
CustodianOfRecord | O | Custodian Of Record |
AssignmentDateTime | R | Assignment Date Time (yyyy-mm-dd) |
BorrowerName | R | Borrower name |
BorrowerEmail | R | Borrower email id |
CoBorrowerName | O | Co-Borrower name |
CoBorrowerEmail | O | Co-Borrower email id |
Transaction > Property | ||
Address1 | R | Property address |
Address2 | R | Property address |
State | R | Property state code |
County | R | Property county |
City | R | Property city |
Zipcode | R | Property zipcode |
Transaction > DocumentList | ||
Count | R | No of documents count |
Transaction > DocumentList > Document | ||
FileName | R | File Name |
FileType | R | Document type. Eg: PDF |
If FileSource is Base 64 | ||
EncodingType | R | Encoded format. Eg: Base64 |
Content | R | Encoded content of the file |
If FileSource is S3/SFTP/LINK | ||
File Path | R | File path of the attachment |
AT50 Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: AT50 |
EventName | O | Name of the event. Eg: OrderComplete |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
OrderNumber | R | Order number of the MAX application |
Comments | O | Comments |
Acknowledgement:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: ACK |
EventName | O | Name of the event. Eg: Acknowledgement |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
Negative Acknowledgement:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of Source application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
EventCode | R | Requested Event Code. Eg: NACK |
EventName | O | Name of the event. Eg: NegativeAcknowledgement |
ClientID | R | ClientID (mentioned under purpose section) |
CorrelationIdentifier | R | Unique number/Hash for the event |
Transaction | ||
TransactionID | R | Order number of the client application |
Transaction > Errors | ||
ErrorCode | R | Error code |
ErrorType | R | Type of error received |
Description | R | Describes about the error |