Tables API 1.0.0

The Tables API exclusive to Dojo integrations

Servers

  • staging-api.dojo.dev/ws/v1/tables/eposwssstaging

    See the required headers to establish the websocket connection.

    Security:
    • HTTP API key
      • Name: Authorization
      • In: header
  • api.dojo.tech/ws/v1/tables/eposwssproduction

    See the required headers to establish the websocket connection.

    Security:
    • HTTP API key
      • Name: Authorization
      • In: header

Operations

  • SUB /ErrorNotification

    Message received from Dojo

    Accepts the following message:

    errorNotification

    A generic error notification.

    Error notification will be sent by Dojo whenever the message sent by the EPOS can't be read.

    object
    uid: errorNotification

    Error notification is used whenever the response received from the EPOS can't be read by Dojo.

    Examples

  • PUB /Error

    Message to send from the EPOS

    Accepts the following message:

    errorResponse

    A generic error response.

    Error response is used whenever the operation cannot be performed due to various reasons. General errors include ERROR_PARSE_ERROR, ERROR_INTERNAL_POS_ERROR and WAITER_INCORRECT_WAITER_ID. Please consult other messages descriptions to find out when to use the other certain error codes

    object
    uid: errorResponse

    A generic error notification.

    Examples

  • SUB /GetBillItems

    Message received from Dojo

    Accepts the following message:

    getBillItemsRequest

    Request Message for 'GetBillItems'

    A request from Dojo for bill items

    object
    uid: getBillItemsRequest

    A request for bill items.

    Examples

  • PUB /GetBillItems

    Message to send from the EPOS

    Accepts the following message:

    getBillItemsResponse

    Successful Response Message for 'GetBillItems'

    A list of bill items from the EPOS.

    object
    uid: getBillItemsResponse

    Examples

  • SUB /GetFullBill

    Message received from Dojo

    Accepts the following message:

    getFullBillRequest

    Request Message for 'GetFullBill'

    A request from Dojo for an itemised bill receipt. If the session does not exist, the EPOS should return SESSION_NO_SUCH_SESSION error. If the bill does not exist, the EPOS should return a BILL_NO_SUCH_BILL error. Otherwise, the EPOS should return a GetFullBill response for the session.

    object
    uid: getFullBillRequest

    Examples

  • PUB /GetFullBill

    Message to send from the EPOS

    Accepts the following message:

    getFullBillResponse

    Successful Response Message for 'GetFullBill'

    An itemised bill receipt from the EPOS. This should return a graphical bill receipt to be printed on the card machine (incl. logos/QR codes etc)

    See the following example to see how the formatting is handled by a Dojo terminal.

    object
    uid: getFullBillResponse

    Examples

  • SUB /GetSession

    Message received from Dojo

    Accepts the following message:

    getSessionRequest

    Request Message for 'GetSession'

    A request from Dojo for a session. If the session does not exist, return SESSION_NO_SUCH_SESSION error message, otherwise return a GetSession response.

    object
    uid: getSessionRequest

    Examples

  • PUB /GetSession

    Message to send from the EPOS

    Accepts the following message:

    getSessionResponse

    Successful response Message for 'GetSession'

    A session from a EPOS. If the session does not exist, the EPOS should return a SESSION_NO_SUCH_SESSION error message.

    object
    uid: getSessionResponse

    Examples

  • SUB /GetTable

    Message received from Dojo

    Accepts the following message:

    getTableRequest

    Request Message for 'GetTable'

    A request from Dojo for a table. If the table doesn't exist, the EPOS should return a SESSION_NO_SUCH_SESSION error message instead, otherwise return a GetTable response.

    object
    uid: getTableRequest

    Examples

  • PUB /GetTable

    Message to send from the EPOS

    Accepts the following message:

    getTableResponse

    Successful Response Message for 'GetTable'

    A table from an EPOS. If the table doesn't exist, the EPOS should return a TABLE_NO_SUCH_TABLE error message instead.

    oneOf

    Examples

  • SUB /ListBillItems

    Message received from Dojo

    Accepts the following message:

    listBillItemsRequest

    Request Message for 'ListBillItems'

    A request from Dojo for multiple bills. The EPOS should return a list of the bills for sessions specified. If no bills can be found, or the specified sessions don't exist, the EPOS should return a ListBillItems response with no bill itms. Omitting sessionIds returns all bill items

    object
    uid: listBillItemsRequest

    Examples

  • PUB /ListBillItems

    Message to send from the EPOS

    Accepts the following message:

    listBillItemsResponse

    Successful Response Message for 'ListBillItems'

    List of bills from a EPOS.

    object
    uid: listBillItemsResponse

    Examples

  • SUB /ListSessions

    Message received from Dojo

    Accepts the following message:

    listSessionsRequest

    Request Message for 'ListSessions'

    A request from Dojo for a list of sessions. If there are filtering params specified, the response from the EPOS should contain only sessions matching all of the filters. If no sessions match the filters, the EPOS should return a ListSessions response with no sessions.

    object
    uid: listSessionsRequest

    Examples

  • PUB /ListSessions

    Message to send from the EPOS

    Accepts the following message:

    listSessionsResponse

    Response Message for 'ListSessions'

    A list of sessions from a EPOS.

    object
    uid: listSessionsResponse

    Examples

  • SUB /ListTables

    Message received from Dojo

    Accepts the following message:

    listTablesRequest

    Request Message for 'ListTables'

    A request for a list of tables. If there are params set, the ListTables response should contain only tables matching all of the filters using AND logic.

    object
    uid: listTablesRequest

    Examples

  • PUB /ListTables

    Message to send from the EPOS

    Accepts the following message:

    listTablesResponse

    Response Message for 'ListTables'

    A list of tables from a EPOS.

    object
    uid: listTablesResponse

    Examples

  • SUB /LockSession

    Message received from Dojo

    Accepts the following message:

    lockSessionRequest

    Request Message for 'LockSession'

    A request from Dojo to lock a specific session. If the session does not exist, the EPOS should return SESSION_NO_SUCH_SESSION error. If it is already locked, the EPOS should return SESSION_ALREADY_LOCKED error. Otherwise, the EPOS should return a LockSession response for the session.

    object
    uid: lockSessionRequest

    Examples

  • PUB /LockSession

    Message to send from the EPOS

    Accepts the following message:

    lockSessionResponse

    Successful Response Message for 'LockSession'

    Contains bill items for the session

    object
    uid: lockSessionResponse

    Examples

  • SUB /RecordPayment

    Message received from Dojo

    Accepts the following message:

    recordPaymentRequest

    Request Message for 'RecordPayment'

    A request from Dojo to record a payment. If the session does not exist, the EPOS should return a SESSION_NO_SUCH_SESSION error. If the session connected to the payment is not locked, the EPOS should return a SESSION_NOT_LOCKED error. If this particular payment has already been recorded, the EPOS should return a PAYMENT_ALREADY_RECORDED error. If the EPOS cannot record the payment for internal reasons, return a PAYMENT_NOT_RECORDED error. If the request is successful, the EPOS should return a RecordPayment response.

    object
    uid: recordPaymentRequest

    Examples

  • PUB /RecordPayment

    Message to send from the EPOS

    Accepts the following message:

    recordPaymentResponse

    Response Message for 'RecordPayment' request

    Confirmation of a payment from a EPOS. An empty result indicates logical success of the request.

    object
    uid: recordPaymentResponse

    Examples

  • SUB /UnlockSession

    Message received from Dojo

    Accepts the following message:

    unlockSessionRequest

    Request Message for 'UnlockSession'

    A request from Dojo to unlock a locked session. If the session is not locked, the EPOS should return SESSION_NOT_LOCKED error. If the EPOS cannot unlock the session due to internal reasons, it should return a SESSION_UNABLE_TO_UNLOCK error. Otherwise, the EPOS should return an UnlockSession response.

    object
    uid: unlockSessionRequest

    Examples

  • PUB /UnlockSession

    Message to send from the EPOS

    Accepts the following message:

    unlockSessionResponse

    Successful Response Message for 'UnlockSession'

    Confirmation of an unlocked session from a EPOS. An empty result indicates success.

    object
    uid: unlockSessionResponse

    Examples

Messages

  • #1errorNotification

    A generic error notification.

    Error notification will be sent by Dojo whenever the message sent by the EPOS can't be read.

    object
    uid: errorNotification

    Error notification is used whenever the response received from the EPOS can't be read by Dojo.

  • #2errorResponse

    A generic error response.

    Error response is used whenever the operation cannot be performed due to various reasons. General errors include ERROR_PARSE_ERROR, ERROR_INTERNAL_POS_ERROR and WAITER_INCORRECT_WAITER_ID. Please consult other messages descriptions to find out when to use the other certain error codes

    object
    uid: errorResponse

    A generic error notification.

  • #3getBillItemsRequest

    Request Message for 'GetBillItems'

    A request from Dojo for bill items

    object
    uid: getBillItemsRequest

    A request for bill items.

  • #4getBillItemsResponse

    Successful Response Message for 'GetBillItems'

    A list of bill items from the EPOS.

    object
    uid: getBillItemsResponse
  • #5getFullBillRequest

    Request Message for 'GetFullBill'

    A request from Dojo for an itemised bill receipt. If the session does not exist, the EPOS should return SESSION_NO_SUCH_SESSION error. If the bill does not exist, the EPOS should return a BILL_NO_SUCH_BILL error. Otherwise, the EPOS should return a GetFullBill response for the session.

    object
    uid: getFullBillRequest
  • #6getFullBillResponse

    Successful Response Message for 'GetFullBill'

    An itemised bill receipt from the EPOS. This should return a graphical bill receipt to be printed on the card machine (incl. logos/QR codes etc)

    See the following example to see how the formatting is handled by a Dojo terminal.

    object
    uid: getFullBillResponse