Login As Guest User

Description¶

The loginAsGuestRole endpoint is used to log a user into the VELA application who is not a registered user of the application.

Request¶

Endpoint

    /ui/v1/loginAsGuestRole  

Method

    POST  

Header

    Content-Type: application/json  

Attributes

ELEMENT	DESCRIPTION
MerchantCode	Required specific code used for each merchant

Request Body

{
    "merchantCode": "VELA"

}

Response¶

{
    "message": {
        "code": "122",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "The Guest User is able to login successfully into the application."
    },
    "locationPath": null,
    "userId": null,
    "channelId": 2,
    "userRoles": null,
    "forceChangePasswordInd": false,
    "userLocale": null,
    "passwordExpiryDaysIn": null,
    "securityQuestionsEnrolledInd": false,
    "userEmail": null,
    "mobile": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "uiType": null,
    "createdUserId": null,
    "unpaidInvoiceCount": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "roleType": {
        "value": "Guest",
        "name": "GUEST"
    },
    "paymentAction": {
        "value": "Sale",
        "name": "SALE"
    },
    "merchantId": 2,
    "invoiceNumber": "EMPTY"
}

Negative Request & Response

If a negative request has been passed, then the Response would be as follows:

Request Body

{
    "merchantCode": "1234"

}

Response

{
    "message": {
        "code": "125",
        "type": {
            "value": "Error",
            "name": "ERROR"
        },
        "text": null,
        "include_i_icon": false,
        "description": "You are not authorized to access this application. For more information, please contact customer service."
    },
    "locationPath": null,
    "userId": null,
    "channelId": null,
    "userRoles": null,
    "forceChangePasswordInd": false,
    "userLocale": null,
    "passwordExpiryDaysIn": null,
    "securityQuestionsEnrolledInd": false,
    "userEmail": null,
    "mobile": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "uiType": null,
    "createdUserId": null,
    "unpaidInvoiceCount": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "roleType": null,
    "paymentAction": null,
    "merchantId": null,
    "invoiceNumber": null
}  

Updated As Of Version 2.2.0.0