/profileactivations/{id}/cancellation · Profile Activation API

API-ReferenzProfile Activation APICancelling a Profile Activation

/profileactivations/{id}/cancellation

Profile Activation API Cancelling a Profile Activation

Laut Confluence ohne Verwendung; historischer Projektstand.

POST/profileactivations/{id}/cancellation

With this resource, you can undo an activation of a Profile made by the previous resource. Please regard, that this resource is meant for cancellations only. It is not allowed to use this resource in case of returns.

Parameter

idstringErforderlich

the Id of the Profile whose activation you want to cancel.

Beispiel: 'ab12345'

Request-Header

DevKey

The `DevKey` that has been provided by qnips, identifying you as a requestor

SecurityToken

This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under 'Generating SecurityToken' of this API documentation

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### /profileactivations/{id}/cancellation [POST]

+ Parameters
    + id (string, `'ab12345'`) ... the Id of the Profile whose activation you want to cancel.

+ Request

    + Headers
    
            DevKey : The `DevKey` that has been provided by qnips, identifying you as a requestor
            SecurityToken : This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under 'Generating SecurityToken' of this API documentation

+ Response 200

    + Body
    
            in case of success, the response body will remain empty

+ Response 400 

        // HTTP-BadRequest: is returned in case you supplied an invalid profileId
        {
            "Message": "no data for your request"
        }

+ Response 401 

        // HTTP-Unauthorized: is returned in case you supplied a wrong DevKey or no DevKey at all
        {
            "Message": "unknown or wrong DevKey"
        }
            
+ Response 401 

        // HTTP-Unauthorized: is returned in case you supplied a wrong SecurityToken or no SecurityToken at all
        {
            "Message": "unknown or wrong SecurityToken"
        }

+ Response 409 

        // HTTP-Conflict: is returned in case the balance of the profile is not equal to the starting balance
        {
            "Message": "not all requirements met"
        }

Request

cURLKopieren

curl --request POST \
  'https://pos.api.qnips.com/api/pos/v3/profileactivations/{id}/cancellation' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'SecurityToken: This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under '\''Generating SecurityToken'\'' of this API documentation'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200400401 · 3401 · 4409

Response 200Kopieren

in case of success, the response body will remain empty

Response 400Kopieren

// HTTP-BadRequest: is returned in case you supplied an invalid profileId
{
    "Message": "no data for your request"
}

Response 401Kopieren

// HTTP-Unauthorized: is returned in case you supplied a wrong DevKey or no DevKey at all
{
    "Message": "unknown or wrong DevKey"
}

Response 401Kopieren

// HTTP-Unauthorized: is returned in case you supplied a wrong SecurityToken or no SecurityToken at all
{
    "Message": "unknown or wrong SecurityToken"
}

Response 409Kopieren

// HTTP-Conflict: is returned in case the balance of the profile is not equal to the starting balance
{
    "Message": "not all requirements met"
}