Articles in this section

See more

GetGameModules

Follow

This operation retrieves a list of all game modules available to the Customer. This operation is usually used when preparing the list of games for the game lobby. For more information about using this operation, see the Games Lobby chapter in the Integration Guide document.

Request

PARAMETER DESCRIPTION FORMAT EXAMPLE
partnerID ID of partner

Unique ID associated with each customer		 GUID D61A14AE-0A0C-464B-B7AB-5900BE7462F9
sign Parameters: partnerID, channel

(for more information, see Creating Data Sign)		 string (64) 5E0A0349AE36AD67 CD21D891AB124CCE 8CC4171C5BD7EF5B 26FCA86DB71F500A
channel Semicolon-separated list of Games distribution channels.

Supported values are Html5 and Flash, if none specified then all game modules from all channels will be returned.		 string Html5

Request example:

REST JSON

POST https://staging.tomhorngames.com/services/gms/RestCustomerIntegrationService.svc/GetGameModules HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 123456
Host: staging.tomhorngames.com
{
  "partnerID" : "9a2e7402-5cef-42ed-84a6-db589ce19fc6",
  "sign" : "7E6D9C85BA066E95817806B65CB70E3B7692FED476E4FB860D79D2DE1B0A310E",
  "channel" : "HTML5"
}

Response

PARAMETER DESCRIPTION FORMAT EXAMPLE
Code Result codes: 0, 1, 11, 12, 1001, 1002, 1003, 1006, 1007, 1010, 1017, 1033  (for more information, see Result Codes) integer 0
Message Description of the error, if one has occurred. This value is filled only in the event that an error takes place. string (256) Cannot find specified identity
BaseURL Base URL for, where information regarding games (logo, preview, description) can be downloaded string http://server/folder/
GameModules List of available game modules for specific channels. The property is set only if the result code is 0 (success)    
GameModule Information about game module    
Key Key of the game module string (16) VS243Crystal_TNP
Channel Game Technology string HTML5
Id Id of the game module Integer 196
Name Name of the game module string (128) 243 Crystal Fruits
Provider Name of Provider string (128) Tom Horn Gaming
Type Type of the game module

One of the Video Slots, Reel Slots, Tables, Video Pokers or Unique Games		 string (128) Tables
Version The version of the game module string 1
Demo
 To show if a game supports demo mode.
 boolean
 true/false
FGBSupport To show if the game supports FreeGamesBonus (FGB)
 boolean
 true/false

Response example:

REST JSON

{
  "BaseURL": "https://server/path/",
  "Code": 0,
  "GameModules": [
    {
      "Channel": "Html5",
      "Id": 196,
      "Key": "VSGeisha_TNP",
      "Name": "Geisha's Fan",
      "Provider" : "Tom Horn Gaming", 
      "Type": "Video Slot",
      "Version": "1.0",
      "Demo":false,
      "FGBSupport":false
    },
    {
      "Channel": "Html5",
      "Id": 195,
      "Key": "VS243Crystal_TNP",
      "Name": "243 Crystal Fruits",
      "Provider" : "Tom Horn Gaming", 
      "Type": "Video Slot",
      "Version": "1.0",
      "Demo":false,
      "FGBSupport":false
    },
    {
      "Channel": "Html5",
      "Id": 194,
      "Key": "VSlotBOS_TNP",
      "Name": "Book of Spells",
      "Provider" : "Tom Horn Gaming", 
      "Type": "Video Slot",
      "Version": "1.0",
      "Demo":true,
      "FGBSupport":true
    },
    {
      "Channel": "Html5",
      "Id": 149,
      "Key": "VSlotDE_TNP",
      "Name": "Dragon Egg",
      "Provider" : "Tom Horn Gaming", 
      "Type": "Video Slot",
      "Version": "1.0",
      "Demo":true,
      "FGBSupport":true
    }
  ],
  "Message": null
}

SOAP

<GetGameModules>
    <Code>0</Code>
    <Message></Message>
    <BaseURL>http://server/folder/</BaseURL>
    <GameModules>
        <GameModule>
            <Key>VSlotDE_TNP</Key>
            <Name>Dragon Egg<Name>
            <Version>1<Version>
            <Type>Video Slot<Type>
            <Channel>HTML5</Channel>
            <FGBSupport>true</FGBSupport>
            <Demo>true</Demo>
        </GameModule>
        <GameModule>
            <Key>VSlotBOS_TNP</Key>
            <Name>Book of Spells<Name>
            <Version>1<Version>
            <Type>Video Slots<Type>
            <Channel>HTML5</Channel>
            <FGBSupport>true</FGBSupport>
            <Demo>true</Demo>
        </GameModule>
        <GameModule>
            <Key>VS243Crystal_TNP</Key>
            <Name>243 Crystal Fruits<Name>
            <Version>1<Version>
            <Type>Video Slots<Type>
            <Channel>HTML5</Channel>
            <FGBSupport>true</FGBSupport>
            <Demo>true</Demo>
        </GameModule>
    </GameModules>
</GetGameModules>

Related articles

Comments

0 comments

Article is closed for comments.