Skip to main content

OVERVIEW

An ALL Loyalty Member can cancel a convertion that has been done from Partner points into ALL points in the Loyalty Hub.

cancelearnimage

 

REQUEST

 

Type Endpoint
 PUT  /loyalty/v1.0/cancelEarnPartner

 

PARAMETERS

 

Parameter Description Status Location Example
apikey (String) API Key value, needed to access the service Required Header l7xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Authorization (String) LEAH's authorization token Required Header  

 

APIm request body [example(s)]

APIm JSON request body 

 

{

  "transactionId": "3544711",

  "partnerCode": "34"

}

APIm response body [example(s)]

APIm JSON response body 

{

  "status": "OK",

  "responseCodes": [

    "1"

  ]

}

APIm's successful return code

200

 

ERRORS

 

Error Handling

JSON error template :

 Développer la source

{

    "error": {

        "message": "Error Message",

        "details": "Error Details",

               "code": "Error Code"

    }

}

 

XML error template :

 Développer la source

<error>

        <message>Error Message</message

        <details>Error Details</details>

        <code>Error Code</code>

</error

 

 

Functional Description

Return Code

Error Message

Error Details

Error Code

If there is an access issue (API Key not provided or not valid, IP address restriction)

401

Authentication Error

You are not allowed to access the service exposed by this gateway

-

If there is an issue with parameters provided in request

400

Invalid Request

Error while retrieving request parameters. Please check your parameters and if they respect restrictions

-

If the request body does not validate the schema

400

Invalid Request

Request body does not validate the schema

-

If the backend is unreachable

500

Internal Server Error

Unable to get a response from backend

-

If there is an error while processing data from backend

500

Internal Server Error

Unable to process data. Please contact API Management team

-

If data from backend is not well-formatted

502

Internal Server Error

Data from backend is not well formatted

-

Default internal error message

500

Gateway Internal Error. Please Contact the administrator

Undefined error

-

 

Other important information :

  • IP Filtering

Implemented features :

  • Duration for cache retention: 
  • Access management: API Key
  • Supervision: logs in access logs file

 

About us

We are far more than a worldwide leader. We are 300,000 hospitality experts placing people at the heart of what we do, and nurturing real passion for service and achievement beyond limits. We take care of millions of guests in our 5,000 addresses.