{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1114412b-eb97-42e4-b490-04319e99cd52","name":"Queaxis 3.0 APIs","description":"## Preface\n\nThis reference guide describes how to use Queaxis™ API’s to integrate with third-party applications.\n\n## Purpose\n\nThis document is intended for Application Developers and Web Developers who are interested in integrating third-party applications with Queaxis™. Before using this reference document you should be familiar with the following:\n\n- techniques required to make a secure connection over the internet (SSL over HTTP)\n- formats/protocols to exchange information between systems (JSON)\n- programming or scripting language to implement\n    \n\n## Copyright\n\nUninand Technologies Inc., All rights reserved.\n\nThis document describes the final release of the software program \"Queaxis™ API\". This document is provided \"as-is\". Information and views expressed in this document, including URL and other Internet Web site references, may change without notice. You bear the risk of using it. Some examples depicted in this document are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred.\n\nThis document does not provide you with any legal rights to any intellectual property in any Uniand products. You may copy and use this document for your internal, reference purposes.\n\n© Queaxis. All rights reserved. All other trademarks are property of their respective owners.\n\n## Terms of Use\n\n**No Warranties:** The Queaxis™ api and all related components and information are provided on an “as is” and “as available” basis without any warranties of any kind, and Uninand expressly disclaims any and all warranties, whether express or implied, including, but not limited to, the implied warranties of merchantability, title, fitness for a particular purpose, and non-infringement. Since it is purely dependent on application hosting environment, You acknowledge that Uninand does not warrant that the api will be uninterrupted, timely, secure, error-free or virus-free, nor does it make any warranty as to the results that may be obtained from use of the api, and no information, advice or services obtained by you from Uninand shall create any warranty not expressly stated..\n\n**limitation on liability:** Under no circumstances and under no legal theory (whether in contract, tort, or otherwise) shall Uninand be liable to you or any third party for any indirect, incidental, special, exemplary, consequential or punitive damages, including lost profits, lost sales or business, lost data, or any matter beyond our reasonable control. The provisions of this section allocate the risks under this tos between the parties, and the parties have relied on these limitations in determining whether to enter into this tos. some jurisdictions do not allow the exclusion of implied warranties or limitation of liability for incidental or consequential damages, which means that some of the above limitations may not apply to you. In these jurisdictions, Uninand’s liability will be limited to the greatest extent permitted by law.\n\n**Indemnity:** you agree to defend, hold harmless and indemnify Uninand and its subsidiaries, affiliates, officers, agents, employees, and suppliers, from and against any third party claim arising from or in any way related to your or your users’ use of the application, api or data, use of Uninand’s brands, or violation of this api tos, including any liability or expense arising from all claims, losses, damages (actual and consequential), suits, judgments, litigation costs and attorneys’ fees, of every kind and nature.\n\n## Overview\n\nQueaxis™ is the most powerful and sophisticated queue management system to manage customer journey; to engage and enhance customer experience at any customer centric location. With over 100+ unique features, Queaxis can be customized to fit any business requirement either through low code or no code. This document outlines and details the ways to configure and manage various modules within Queaxis - Queue Management System hereafter referred to as system.\n\n## Integration & Authorization\n\nClient Id and Secret are required to use with APIs, these credentials can be created and retrieved by logging into Queaxis™ Config Manager and browse through Settings > Integrations > Clients\n\n**Basic Auth (Header)**\n\nThe Authorization header is constructed as follows:\n\n1. The Client Id and Secret are combined with a single colon (:)\n2. The resulting string is encoded using a variant of Base64 (+/ and with padding).\n3. The authorization method (\"Basic\") and a space character is then prepended to the encoded string.\n    \n\nFor example `Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`\n\n**API Key (Query Param)**\n\nThe Api Key is constructed as follows:\n\n1. The Client Id and Secret are combined with a single colon (:)\n2. The resulting string is encoded using a variant of Base64 (+/ and with padding).\n3. The encoded string is then sent as query string with parameter \"authz_token\"\n    \n\nFor example `?authz_token=QWxhZGRpbjpvcGVuIHNlc2FtZQ==`\n\n## Request & Response\n\nQueaxis™ APIs are RESTful and implement Post, Get, Put and Delete HTTP methods for CRUD operations and return JSON data. The request body supports raw JSON, application/json form-data and x-www-form-urlencoded. Queaxis™ is recommended to be hosted over SSL so the API endpoints will be accessed on HTTPS.\n\n| **Methods & Variables** |  |\n| --- | --- |\n|   <br>  <br>{{host}}  <br>  <br> |   <br>  <br>IP or FQDN resolving to SchdMngr Server  <br>  <br> |\n| {{port}} | Port at which SchdMngr server is listening (typically 443) suffixed by the path (eg. /queaxis/be) |\n| Get | HTTP Get method typically used for find or fetch data from the server |\n| Post | HTTP Post method typically used for create, add new records into the server |\n| Put, Patch | HTTP Put method typically used to update existing records on the server. SchdMngr update APIs allow partials. Refer to respective API sections for more details. |\n| Delete | HTTP Delete method typically used to delete, remove existing records in the server. SchdMngr delete APIs only do soft delete. Meaning the actual records are retained as per policy set. |\n| Param | Represents the variables as part of URI path. E.g /api/:id, where :id is a Param variable |\n| Body | Represents the variables as part of the request body. SchdMngr APIs accept raw JSON, form-data and x-www-form-urlencoded. Refer to respective API sections for more details. |\n| Query |  |\n\n| **Response Codes** |  |\n| --- | --- |\n| **200** Ok  <br>**201** Created  <br>**204** No Content  <br>**304** Not Modified  <br>**400** Bad Request | **401** Unauthorised  <br>**403** Forbidden  <br>**404** Not Found  <br>**409** Conflict  <br>**500** Internal Server Error |\n\n**Sample Error Response (401 Unauthorised)**\n\n``` json\n{\n    \"statusCode\": 401,\n    \"message\": \"Token Expired\",\n    \"error\": \"Unauthorized\"\n}\n\n```\n\n**Sample Error Response (400 Bad Request)**\n\n``` json\n{\n    \"statusCode\": 400,\n    \"message\": [\n        \"workplace must be a UUID\",\n        \"service must be a UUID\",\n        \"group must be a UUID\"\n    ],\n    \"error\": \"Bad Request\"\n}\n\n```\n\n## Reponse Localization\n\n\\[TODO\\]\n\n``` json\n•••\n\"nameI18n\": {\n    \"baseScript\": \"Service 1\",\n    \"tranScript\": [\n        {\n            \"text\": \"الخدمة 1\",\n            \"code\": \"ar_AE\",\n            \"rtl\": true,\n            \"isDefault\": false\n        }\n    ]\n},\n•••\n\n```\n\n## Response Filter & Pagination\n\n**Filter** ?filter={:{:}\n\n| **Operator** | **Description** | **Operator** | **Description** |\n| --- | --- | --- | --- |\n| lk | Like | nlk | Not Like |\n| in | Includes In Array | nin | Not Includes in Array |\n| eq | Equals | ne | Not Equals |\n| gt | Greater Than | gte | Greater Than and Equals |\n| lt | Less Than | lte | Less Than and Equals |\n\nFor example `?filter={\"createdAt\":{\"gte\":\"2023-01-01T00:00:00.000\"}}&filter={\"createdAt\": {\"lte\":\"2023-01-01T23:59:59.999\"}}`\n\n**Sort** ?sort={:< ASC | DESC >}\n\nFor example `?sort={\"name\":\"ASC\", \"createdAt\": \"DESC\"}`\n\n**Pagination** ?page=&limit=\n\nFor example `?page=1&limit=5`\n\n``` json\n\"result\":[•••]\n\"pagination\": { \"limit\": 5, \"page\": 1, \"count\": 3 }\n\n```\n\n**Debug** ?debug=ture\n\n``` json\n\"debug\": {\n    \"page\": 1,\n    \"limit\": 5,\n    \"debug\": true,\n    \"sort\": {\n        \"name\": \"ASC\",\n        \"slug\": \"DESC\"\n    },\n    \"filter\": [\n        {\n            \"Workplace.name\": {\n                \"lk\": \"default\"\n            }\n        },\n        {\n            \"Workplace.slug\": {\n                \"eq\": \"admin\"\n            }\n        }\n    ]\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10770462","team":854813,"collectionId":"1114412b-eb97-42e4-b490-04319e99cd52","publishedId":"2s93XyTiCb","public":true,"publicUrl":"https://docs.queaxis.com","privateUrl":"https://go.postman.co/documentation/10770462-1114412b-eb97-42e4-b490-04319e99cd52","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3C78D8"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.0","publishDate":"2023-04-16T14:03:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8549950286330fc15b2b583b5b3cc0a951799ea6d7987f31c79779071fef3e4e","favicon":"https://queaxis.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.queaxis.com/view/metadata/2s93XyTiCb"}