The Nemo-Q REST API (Henceforth called “the API”) is based on a root path of
https://[your address]/NQC/NQWebServices/ which all API calls will be
based upon.
Nemo-Q uses certain terminology to specify what type of queueing information is being transferred. This terminology will be explained under this section. For those who are new to developing with REST API’s the terminology will be highlighted in bold throughout the document, so that you can search the internet for a suitable explanation.
\nThe following terminology can be found in the responses from the API:
\nUnit Type – This refers to one of 3 types of queues. The “Servicetype” which refers to a service provided by your institution, such as “Customer Service” or “Loans”. The “Workstation Queue” which refers to a specific workstation. The “User queue” which refers to a queue where customers have to see a specific person to handle their issue.
\nUnit Number – The Unit Number is a numerical shorthand for subcategories within the Unit Types. For an example within your organization the “Customer Service” Service Type might have the numerical shorthand “1”. Workstation 2 would logically be named “2”. And “Bob Bobson” from the sales department might have the number 1.
\nQueue Type – Specifies if the queue is main, secondary, or booked. Where Main is the default queue when you take a ticket, Secondary means you have been transferred to another queue and Booked means that you have a booking rather than a drop-in number.
\nPrinter Text Number – A numerical identifier which represents the text to be displayed on the ticket you are printing. This number comes from the setup done in the NQC Configuration software which powers much of our queue systems.
\nPrinter Number – The numerical identifier given to a specific ticket-printer, as specified in the NQC/Engine software.
\nLogo – The numerical identifier given to a specific Logotype to be printed onto each ticket, as specified in the NQC software. This function depends on what printer the system is using.
\nVirtual Cashier – There are cases where a “Virtual Cashier” is used, such as when a cashier wants to call a customer to another workstation than the one, they are managing. A common setup is when customers are called to a display where other service personnel can help the customer.
\nMain Queue / Secondary Queue / Booked Queue – Let’s say a customer takes a ticket to see Customer Service, then Customer Service is their Main Queue. However, if it turns out that what they needed help with isn’t a Customer Service issue but rather an “Insurances” issue then the ticket could be forwarded to the “Insurances secondary queue” or to a cashier that work with “Insurances” or to a User that work with “Insurances”, I ticket that are send to another queue is always going to a “secondary” queue. A Booked Queue on the other hand is in parallel to the Main Queue but the person with a booked ticket has an appointed time. To prioritize booked customers with appointment times over regular customers the system needs to be set up to do so.
\nTicket Number – A numerical value such as “505”.
\nTicket Name – A value such as “B505”.
\nLost Ticket – A ticket can either be manually
set to lost or the system can be configured to automatically set a ticket to lost if the service time is shorter than X time units.
When working with the API the typical workflow is as follows:
\nGet the GUID for the office you are working with
\nGet a JSON Web Token
\nMake a call to the webservice to get the information you need
\nAuthenticating for branch-specific requests
\nAll requests that interact with a branch’s queueing engine require the API client to acquire a JSON Web Token (JWT) to do this. This token is secured and locked to the branch, and like all JWTs it has a set time during which it is valid. After the token has expired, a new token must be acquired.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6159398","collectionId":"1673fe27-22d3-47e0-a053-abd51b7ab156","publishedId":"2sB2ixjZ92","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"19373b"},"publishDate":"2025-04-23T13:48:28.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get token","event":[{"listen":"test","script":{"id":"ed542596-7556-4339-ab94-902705d67690","exec":["var jsonData = JSON.parse(pm.response.text());\r","pm.collectionVariables.set(\"access_token\", jsonData[\"access_token\"]);"],"type":"text/javascript","packages":{}}}],"id":"c286cb25-6ccd-4a2f-a201-9211357064c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"officeGuid","value":"","type":"text"}]},"url":"http://example.com/NQC/NQWebServices/oauth2/token","description":"Authenticating for branch-specific requests
\nAll requests that interact with a branch’s queueing engine require the API client to acquire a JSON Web Token (JWT) to do this. This token is secured and locked to the branch, and like all JWTs it has a set time during which it is valid. After the token has expired, a new token must be acquired.
\n","urlObject":{"path":["oauth2","token"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"5d31fada-9ff4-49c5-97b9-a2be7835844a","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Authorization","value":"BearerGet a list of all offices
\nFor retrieving info on a particular office, perform an HTTP GET to the path /api/offices/{id} where the ID field corresponds to either the office INDEX (integer value) or its GUID (string value), depending on your needs or what information you have at hand.
\nThis function does not require authentication beyond any server-level mechanisms.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843","id":"263d1a3c-41c5-42d3-906e-828a3cd19843","name":"Office Interaction","type":"folder"}},"urlObject":{"path":["api","offices"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"23fe126d-552b-4dae-8627-8eb1e6e42026","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerRetrieve information about a specific office based on the index of the office
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843","id":"263d1a3c-41c5-42d3-906e-828a3cd19843","name":"Office Interaction","type":"folder"}},"urlObject":{"path":["api","offices","1"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"8038d1c0-4cba-43fd-8834-9d191d900af5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerRetrieve information about a specific office based on the GUID of the office
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843","id":"263d1a3c-41c5-42d3-906e-828a3cd19843","name":"Office Interaction","type":"folder"}},"urlObject":{"path":["api","offices",""],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"af1a2863-c1d7-43ce-b7de-f8278f67d76a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerGet a list of all servicetypes for the specified office
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843","id":"263d1a3c-41c5-42d3-906e-828a3cd19843","name":"Office Interaction","type":"folder"}},"urlObject":{"path":["api","offices","","servicetypes"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"052b6e0e-840e-4777-8d95-6305a0a709a0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerGet a list of priorities specified for the office
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843","id":"263d1a3c-41c5-42d3-906e-828a3cd19843","name":"Office Interaction","type":"folder"}},"urlObject":{"path":["api","offices","","prioritylist"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"7735cb4f-99e6-4af9-9737-45b3ed3994b7","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerRequests related to office specific tasks
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"66e3e7ab-ca34-44c5-ab07-a228a7de566e"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"d0bf5b77-44d6-42d9-80ea-79610204c3dc"}}],"_postman_id":"263d1a3c-41c5-42d3-906e-828a3cd19843"},{"name":"User Interaction","item":[{"name":"Get user queue information by ID","id":"af034764-c7d9-400c-8d7f-14dc789edee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"http://example.com/NQC/NQWebServices/api/queueinfo/user/1","description":"Get the queue information for the specified user
\n","urlObject":{"path":["api","queueinfo","user","1"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"81957a33-5027-4289-8f46-75d54e44c527","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerGet the queue information for all users
\n","urlObject":{"path":["api","queueinfo","user"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"2da2be0c-8e0d-4012-a9c4-4958b3f384ae","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerGet a list of priorities assigned to the specified user
\n","urlObject":{"path":["api","user","1","priorities"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"36be947b-8453-41ca-a8f7-1e3da02184f1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"BearerSet the priority of the provided user to the priority with the provided number
\n","urlObject":{"path":["api","user","1","priority","1"],"host":["http://example.com/NQC/NQWebServices"],"query":[],"variable":[]}},"response":[{"id":"c2be6d16-5038-4bbe-8b19-14f89889a8a9","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Bearer