Guides
Log In
Guides

Commande getTables (obtenir les tables)

Vue d'ensemble

La commande getTables (obtenir les tables) renvoie une liste des tables ouvertes attribuées au serveur.


Structure de la requête

ÉLÉMENTTYPEDESCRIPTIONTAILLEOBLIGATOIRE
terminalIdStringIdentifiant du terminal à l'origine de la requêteV8Obligatoire
merchantIdStringIdentifiant du commerçant à l'origine de la requêteV13Obligatoire
apiVersionStringNuméro de version de l'APIV20Obligatoire
requestIdStringIdentifiant unique pour cette requêteV50Obligatoire
requestTimestampStringDate et heure de la requêteF19Obligatoire
actionStringType de transaction – « getTables »V24Conditionnel
dataObjectDonnées applicables à ce type de transaction
serverObject
serverIdStringIdentifiant du serveur saisi sur le terminalV50Optionnel
trackDataObject
Track1StringPiste 1 de la carte serveur balayéeV50Optionnel
Track2StringPiste 2 de la carte serveur balayéeV50Optionnel
Track3StringPiste 3 de la carte serveur balayéeV50Optionnel
errorObjectPrésent si le terminal détecte une erreur dans la réponse précédente. Applicable à toutes les actions.
statusStringCode d’étatF3Conditionnel
statusDescStringDescription du code d’étatV50Conditionnel
sessionStringIdentifiant de session provenant du cloud MonerisV50Conditionnel


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "apiVersion": "1.0",
   "requestId": "I9000001-1555449670-037",
   "requestTimestamp": "2020-01-01 09:00:00",
   "action": "getTables",
   "data": {
      "server": {
         "serverId": "1234",
         "trackData": {
            "track1": "",
            "track2": "",
            "track3": ""
         }
      }
   },
   "error": {
      "status": "703",
      "statusDesc": "Table Number Error"
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}

Structure de la réponse

ÉLÉMENTTYPEDESCRIPTIONTAILLEOBLIGATOIRE
terminalIdStringIdentifiant du terminal à l'origine de la requêteV8Obligatoire
merchantIdStringIdentifiant du commerçant à l'origine de la requêteV13Obligatoire
configCodeStringCode de configuration d’intégration fourni par MonerisV25Obligatoire
requestIdStringIdentifiant unique pour cette requêteV50Obligatoire
requestTimestampStringDate et heure de la requêteF19Obligatoire
statusStringCode d’état RMSF3Obligatoire
statusDescStringDescription du code d’état RMSV50Obligatoire
dataObjectDonnées applicables à ce type de transaction
tablesArrayUn tableau d’objets table
tableIdStringClé primaire, utilisée dans les requêtes suivantes pour cibler une table en particulierV50Obligatoire
tableNameStringNom de la table pour affichage dans l’interface utilisateur du terminalV50Obligatoire
tableTotalAmountNumberMontant total dû pour la table (en cents)V9Obligatoire
tableRemainingAmountNumberMontant restant dû, autorisation partielle (en cents)V9Obligatoire
sessionStringIdentifiant de session provenant du cloud MonerisV50Conditionnel


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "configCode": "C12345678SI",
   "requestId": "I9000001-1555449670-037",
   "responseTimestamp": "2020-01-01 09:00:00",
   "status": "600",
   "statusDesc": "Internal Error",
   "data": {
      "tables": [
         {
            "tableId": "5cbb687bb376894ed03662db",
            "tableName": "DiningRoom1",
            "tableTotalAmount": 12300,
            "tableRemainingAmount": 12300
         },
         {
            "tableId": "5cbb687bb376894ed03662dc",
            "tableName": "0002",
            "tableTotalAmount": 15000,
            "tableRemainingAmount": 15000
         },
         {
            "tableId": "5cbb687bb376894ed03662ec",
            "tableName": "7",
            "tableTotalAmount": 20000,
            "tableRemainingAmount": 19000
         }
      ]
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}