Skip to main content
API docs by Redocly

Lineberty Display API (1.0.0)

Download OpenAPI specification:Download

Lineberty Developer Support: contact@lineberty.com URL: https://www.lineberty.com

About Lineberty

Lineberty is a Booking System that increases user satisfaction by reducing the time spent to wait for her/his turn.

The user simply has to book a ticket, either on her/his phone using your application, or on a terminal you’re providing at your place, then to select the time when s/he wants to enjoy visiting your place or use your service. That’s so simple! No need to stay and wait anymore.

Freed by the Lineberty Booking System, the user now has time to visit around or make more purchases. Shortly before her/his appointment, the user receives a notification informing her/im that it’s almost her/his turn.

About the Lineberty Display API

Create your own Display (web)application to project on a screen the evolution of the queues and inform the users that they are progressing.

The Display API helps your clients to see the current state of the queue and let them known the estimated time left before their passage.

Authentication

Your Display application will have to communicate with the Lineberty server to get the data needed to display a ticket. This communication requires an API Key.

We will provide you with a private key included in a JSON file. This JSON file must be stored safe on your application server.

This private key also contains an email address associated to your account to access the Lineberty Display API, and afterwards get the API Key.

See The Lineberty Display API User Guide for further information.

API KEY

The API Key secures the communication with the Lineberty Server.

GET A VALID API KEY

This is the first step before accessing the resources of the API. Use this route to get a valid API Key to access the Lineberty Display API resources with your private key. We recommend to use API Key caching to optimize the number of requests per day and resend the request once a day.

Authorizations:
server_key_file

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/api_key

Response samples

Content type
application/json
{
  • "apiKey": "QJ15bv43hKXTpVClbyMnofYOXHZdyb2Lxwv8yEpzrV1laO"
}

COMPANIES

Use these routes to get the list of the companies, and for each company the places relating to it.

GET ALL THE COMPANIES ASSOCIATED WITH THE API KEY

Use this route to get the list of all the companies that are associated with the API key.

Authorizations:
api_key
query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/companies

Response samples

Content type
application/json
{
  • "companyId1": {
    }
}

GET ALL THE PLACES OF THE COMPANY

Use this route to get all the places of the company.

Authorizations:
api_key
path Parameters
companyId
required
string

The ID of the company.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/companies/{companyId}/places

Response samples

Content type
application/json
{
  • "placeId1": {
    },
  • "placeId2": {
    }
}

PLACES

Use these routes to get the list of the places, and for each place the queues, endpoints and time slots relating to it.

GET PLACES

Use this route to get all the places associated with the API key.

Authorizations:
api_key
query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places

Response samples

Content type
application/json
{
  • "placeId1": {
    },
  • "placeId2": {
    }
}

GET THE PLACE

Use this route to get a place in particular, using its place ID.

Authorizations:
api_key
path Parameters
placeId
required
string

The ID of the place.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places/{placeId}

Response samples

Content type
application/json
{
  • "placeId": "placeId1",
  • "companyId": "companyId1",
  • "name": {
    },
  • "address": "5 Avenue Anatole France",
  • "city": "Paris",
  • "country": "France",
  • "zip": "75007",
  • "language": "fr_FR",
  • "timezone": "Europe/Paris",
  • "position": {
    }
}

GET THE QUEUE(S) OF THE PLACE

Use this route to get the queue(s) of the place.

Authorizations:
api_key
path Parameters
placeId
required
string

The ID of the place.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places/{placeId}/queues

Response samples

Content type
application/json
{
  • "queueId1": {
    },
  • "queueId2": {
    }
}

GET THE COUNTER(S) OF THE PLACE

Use this route to get the counter(s) of the place.

Authorizations:
api_key
path Parameters
placeId
required
string

The ID of the place.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places/{placeId}/counters

Response samples

Content type
application/json
{
  • "counterId1": {
    },
  • "counterId2": {
    }
}

GET THE ENDPOINT(S) OF THE PLACE

Use this route to get the endpoint(s) of the place.

Authorizations:
api_key
path Parameters
placeId
required
string

The ID of the place.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places/{placeId}/endpoints

Response samples

Content type
application/json
{
  • "endpointId1": {
    },
  • "endpointId2": {
    },
  • "endpointId3": {
    }
}

GET THE TIME SLOT(S) OF THE PLACE

Use this route to get the time slot(s) of the place. By default, the time slots are those of the current day.

Authorizations:
api_key
path Parameters
placeId
required
string

The ID of the place.

query Parameters
startAt
string

The start date of the time slot to select data.

endAt
string

The end date of the time slot to select data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/places/{placeId}/timeslots

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

QUEUES

Use these routes to get the list of the queues, the configuration of a queue in particular or the tickets of queues.

GET ALL THE QUEUES

Use this route to get all the queues that are associated with the API key.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues

Response samples

Content type
application/json
{
  • "queueId1": {
    },
  • "queueId2": {
    }
}

GET ALL THE ENDPOINTS OF THE QUEUES

Use this route to get the list of all the endpoints of the queues.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues/endpoints

Response samples

Content type
application/json
{
  • "endpointId1": {
    },
  • "endpointId2": {
    },
  • "endpointId3": {
    }
}

GET ALL THE CURRENT TICKETS OF THE DAY AND THE TICKET EVENTS

Use this route to get in real time all the current tickets (i.e. excluding those that are done or canceled) that are planned for today on the first message, then all the ticket events.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

page
number

The page number needed. 1 by default because there is at least one page.

pageSize
number [ 1 .. 50 ]
Default: 20

The number of items to return for each page. By default, a page contains 20 items, at least 1 and up to 50.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues/tickets/currents/sse

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "page": 1,
  • "pageSize": 20,
  • "tickets": [
    ]
}

GET ALL THE CURRENT TICKETS OF THE DAY

Use this route to get all the current tickets (i.e. excluding those that are done or canceled) that are planned for today.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

page
number

The page number needed. 1 by default because there is at least one page.

pageSize
number [ 1 .. 50 ]
Default: 20

The number of items to return for each page. By default, a page contains 20 items, at least 1 and up to 50.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues/tickets/currents

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "page": 1,
  • "pageSize": 20,
  • "tickets": [
    ]
}

GET ALL THE DONE OR CANCELLED TICKETS OF THE DAY

Use this route to get all the tickets that have been done or canceled during the current day.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

page
number

The page number needed. 1 by default because there is at least one page.

pageSize
number [ 1 .. 50 ]
Default: 20

The number of items to return for each page. By default, a page contains 20 items, at least 1 and up to 50.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues/tickets/history

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "page": 1,
  • "pageSize": 20,
  • "tickets": [
    ]
}

GET THE STATE OF THE QUEUE AND THE QUEUE STATE EVENTS

Use this route to get the current state of the queue on the first message, then all the queue state events in real time.

Authorizations:
api_key
query Parameters
queuesId
Array of strings

An array of queue IDs.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/queues/state/sse

Response samples

Content type
application/json
{
  • "resource": "string",
  • "actionCategory": "ALL_QUEUE_STATE",
  • "actionName": "ALL_DATA",
  • "data": { }
}

COUNTERS

Use these routes to get the list of the counters, and to increment or decrement the value of the counter.

GET ALL THE COUNTERS

Use this route to get all the counters that are associated with the API key.

Authorizations:
api_key
query Parameters
countersId
required
Array of strings

An array of ID of counter.

langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/counters

Response samples

Content type
application/json
{
  • "counterId1": {
    },
  • "counterId2": {
    }
}

GET ALL THE COUNTERS AND AN EVENT

Use this route to get all the counters that are associated with the API and receive an event each time a counter is incremented/decremented.

Authorizations:
api_key
query Parameters
countersId
required
Array of strings

An array of ID of counter.

langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/counters/sse

Response samples

Content type
application/json
{
  • "counterId1": {
    },
  • "counterId2": {
    }
}

GET THE COUNTER

Use this route to get a counter in particular, using its counter ID.

Authorizations:
api_key
path Parameters
counterId
required
string

The ID of the counter.

query Parameters
langs
Array of strings
Items Enum: "fr_FR" "en_US" "es_ES" "de_DE" "zh_CN" "zh_TW" "ja_JP" "ko_KR" "th_TH"

An array of locales, used to get the translated names of the data.

Responses

Request samples 

curl -X GET \
 -H "Content-Type: application/json" \
 https://api-display.lineberty.net/v1/counters/{counterId}

Response samples

Content type
application/json
{
  • "counterId": "counterId1",
  • "placeId": "placeId1",
  • "companyId": "companyId1",
  • "name": {
    },
  • "language": "en_US",
  • "timezone": "Europe/Paris",
  • "infos": {
    }
}

QUEUE INFORMATION

CHECK THE STATE OF THE QUEUES

Use this route to get information on the current state of the queues (whether open or closed, full, etc.).

Authorizations:
api_key
Request Body schema:
required

All the data to get state information.

queuesId
required
Array of strings

An array of queue IDs (required).

Responses

Request samples

Content type
{
  • "queuesId": [
    ]
}

Response samples

Content type
application/json
{
  • "queueId1": {
    },
  • "queueId2": {
    }
}