Resources
The Lineberty Validation API allows you manage the following resources, by using either a GET, a POST, a PUT or a DELETE method.
|--- Companies
| |---- Places
| |
| |--- Operators
| |
| |--- Queues
| | |--- Endpoints
| | |--- Tickets
| | |--- Counters
Read Resources - GET
Resources | Possible actions |
---|---|
API Key | Get a valid API Key |
Operators | - Get the operator roles - Refresh the session token |
Companies | - Get the list of companies for a given API Key - Get all the places of a company |
Places | - Get the list of places for a given API Key - Get a place - Get the queues of a place - Get the counters of a place - Get the endpoints of a place - Get the time slots of a place |
Queues | - Get all the queues - Get a queue in particular - Get the configuration of a queue - Get all the endpoints of a queue - Get all the indicators of a queue - Get all the current tickets - Get all the ticket events - Get all done or canceled tickets - Get all the tickets booked for the next days |
Counters | - Get all the counters - Get an event on incremented/decremented counters - Get a counter in particular |
Tickets | - Get a ticket - Recall a ticket |
Endpoints | - Get an endpoint - Get an endpoint with real-time updated data - Get the time slots of an endpoint |
Create Resources - POST
Resources | Possible actions |
---|---|
Operators | Login an operator, pre-login an operator, assign and endpoint to a session |
Queues | Filter the tickets of a queue |
Modify Resources - PUT
Resources | Possible actions |
---|---|
Queues | Suspend and resume the queue |
Counters | Increment the counter value |
Tickets | Change a ticket state, define the extended attributes of a ticket |
Endpoints | Open or close an endpoint, set the time slots of an endpoint |
Delete Resources - DEL
Resources | Possible actions |
---|---|
Operator | Disconnect an operator |
Counters | Decrement the counter value |
Endpoints | Delete the time slots of an endpoint |