Exclusions

Exclusions Endpoints

This section will display all available endpoints to get exclusions data.

Subsections of Exclusions

Exclusions Configuration

Get Exclusion Time Periods. use gateway.[msdomain]

Request (GET)

/gateway/exclusions/{version}/configuration/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player login session.

Response

Status 200

{
  "self_exclusion": [
    "6_months",
    "1_year",
    "2_years",
    "5_years"
  ],
  "exclusion_types": {
    "self_exclusion": "self_exclusion",
    "account_closure": "account_closure",
    "timeout": "timeout"
  },
  "account_closure": [
    "problem",
    "bugs",
    "other"
  ],
  "timeout": [
    "1_day",
    "1_week",
    "6_months"
  ]
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Immediate Player Exclusion

Insert immediate player exclusion. use gateway.[msdomain]

Request (POST)

/gateway/exclusions/{version}/immediate/{brand_id}/{player_id}

Parameters:

{
  "exclusion_type": "self_exclusion",
  "period": "6_months",
  "reason": "other",
  "request_by": "player"
}
Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
player_id path int true Player unique ID.
x-auth-token header string true Player login session.
exclusion_type body string true type of exclusion.
period body string true period of exclusion, relevant only for timeout and self_exclusion.
reason body string true reason of exclusion, relevant only for account_closure.

Response

Status 201

"added exclusion"

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}