API - SH59 UI REST

Representational State Transfer (REST) is a software architecture style consisting of guidelines and best practices for creating scalable web services. REST is a coordinated set of constraints applied to the design of components in a distributed hypermedia system that can lead to a more performant and maintainable architecture.

Thanks to this API – if you embed it – your system is going to be able to handle SH59 feature from any mobile device and other desktop application (OS independent). This documentation will guide you through the APIs structure and will help you understand the background info.

General Informations

At every API request it is neccessary to give an identifier for security reasons which provides the query to be insured by the Q-net server.
At requests that happens before ticket calls a ‘KEY’ hash parameter is needed at the URL as a variable. In order to generate a new ticket you will need a ‘KEY’ hash which is generated by the server. This hash contains a timestamp so the server only accepts those hash keys which were generated in the given timestamp.
This way the server can guarantee that one hash key can only be used once. This has is included in the Smart Ticket QR code.

Example

GET http://qnet-server:3000/qnet6/rest/smart/init?key=plTwVw86PjZ

When a ticket is requested or printed, then you can use the ticket parameter from the ticket indetifier insted of the key paramater. The ticket parameter must used as an URL variable.

GET http://qnet-server:3000/qnet6/rest/smart/init?ticket=6gTpJQ67Zmn

API test with Postman

You can try the below listed REST APIs with Postman Collection.

Postman collection
Right click “copy link” then at Postman “Import” and paste link.

Response header codes

Code Name Description
200 SC_OK The request succeeded normally
400 SC_BAD_REQUEST The value of the variable is missing and / or incorrect.
401 SC_UNAUTHORIZED User not identified, not logged in.
403 SC_FORBIDDEN The server understood the request but refused to fulfill it.
404 SC_NOT_FOUND The specified entity could not be found.
500 SC_INTERNAL_SERVER_ERROR There was an error, the returned message will describe exactly what (unexpected but handled error)

Check

Get counter information and keep alive.

Request
GET /qnet6/rest/v2/counter/{wsid}/check;jsessionid={{jsessionid}}
Request example
http://localhost:3000/qnet6/rest/v2/counter/counter1/check;jsessionid={{jsessionid}}
Parameters
Name Type Description
wsid String Counter wsID
Request body

No request body.

Fields
Name Type Description
cntId Number Counter ID
server.serverID Number Server ID
server.wsID String Server wesocet id
server.description String Server description
server.URL String Server url
counter.counterID Number Counter ID
counter.wsID String Counter wesocet id
counter.description String Counter description
branch.branchID Number Branch ID
branch.branchName String Branch name
branch.branchTime Number Branch actual time
userData Object Logged in user information (Only logged in user)
ticket Object Ticket information (only he working on ticket) (Only logged in user)
Response example
{
	"server": {
        "wsID": "master",
        "description": "Master server",
        "serverID": 1,
        "URL": "http://192.168.51.123:3000/qnet6"
    },
    "counter": {
        "wsID": "counter1",
        "description": "Web counter 1",
        "counterID": 1
    },
    "branch": {
        "branchID": 1,
        "branchTime": 20210415154149,
        "branchName": "Default branch"
    },
	"userData": {
		"branchID": 1,
		"counterID": 1,
		"wsID": "counter1",
		"clientID": "0",
		"deviceID": "19",
		"userID": 5,
		"userName": "User 1",
		"loginEventID": 181,
		"languageID": 1,
		"languageCode": "en-gb",
		"signOnTime": 1596523987811,
		"autoCallEnabled": false,
		"dispenserProfileID": 0,
		"customerDataID": 0,
		"selectedBranches": [],
		"roles": {
			"1": [
				3
			]
		},
		"languages": [
			1
		],
		"jSessionID": "BE64A2F60224654D4ECC5FEECA211D26"
	},
	"ticket": {
		"tcId": 23,
		"atcNumber": "1",
		"atc1Time": 20200804075234,
		"atcTicketTime": 20200804075234,
		"atcMTime": 20200804075311,
		"atcType": 1,
		"atcSta": 30,
		"atcSelTask": 1,
		"atcPriority": 5,
		"atcPrint": "Y",
		"atcDelayed": "N",
		"atcWaitSum": 37,
		"atcWaitNum": 1,
		"atcWaitTime": 60,
		"atcCallNum": 0,
		"language": {
			"lngId": 1,
			"lngCode": "en-gb",
			"lngName": "English"
		},
		"tasks": [
			{
				"attId": 23,
				"attSta": 20,
				"tskId": 1,
				"tskIdNum": 1,
				"tskName": "Service 1",
				"tlName": "Service 1 - EN",
				"attZeroTask": "N",
				"attAfterwork": "N",
				"attWorkTime": 0
			}
		]
	}
}

Keepalive

Keep alive counter.

Request
GET /qnet6/rest/v2/counter/{wsid}/keepalive;jsessionid={{jsessionid}}
Request example
http://localhost:3000/qnet6/rest/v2/counter/counter1/keepalive;jsessionid={{jsessionid}}
Parameters
Name Type Description
wsid String Counter wsID
Request body

No request body.

Fields

No any field.

Response example
{}

Login

Login user to counter.

Request
POST /qnet6/rest/v2/counter/{wsid}/login
Request example
http://localhost:3000/qnet6/rest/v2/counter/counter1/login
Parameters

No any parameter.

Request body
Key Type Description
username String User login
password String User password
Fields
Key Type Description
userData Object Logged in user information
avatar String User profile picture url
branchTime Number Branch actual time
Response example
{
	"userData": {
		"wsID": "counter1",
		"clientID": "0",
		"deviceID": "19",
		"loginEventID": 183,
		"autoCallEnabled": false,
		"userID": 5,
		"branchID": 1,
		"counterID": 1,
		"userName": "User 1",
		"languageCode": "en-gb",
		"languageID": 1,
		"signOnTime": 1596528646137,
		"dispenserProfileID": 0,
		"customerDataID": 0,
		"selectedBranches": [],
		"roles": {
			"1": [
				3
			]
		},
		"jSessionID": "59498A0B3F99630E7336C2EA3B6534E4",
		"languages": [
			1
		]
	},
    "avatar": "/qnet6/files?name=user-photos/user_5.png",
    "branchTime": 20210415154216
}

Login with SSO

Login user to counter with SSO.
Before calling the REST API, you should open the /qnet6/sso URL in an iframe in order to the browser be able to manage the SSO authentication. The iframe body will contain the signed username and the jSessionID.

Request
POST /qnet6/rest/v2/counter/{wsid}/loginSSO;jsessionid={{jsessionid}}
Request example
http://localhost:3000/qnet6/rest/v2/counter/counter1/loginSSO;jsessionid={{jsessionid}}
Parameters
Name Type Description
wsid String Counter wsID
Request body

No request body.

Fields
Key Type Description
userData Object Logged in user information
avatar String User profile picture url
branchTime Number Branch actual time
Response example
{
	"userData": {
		"wsID": "counter1",
		"clientID": "0",
		"deviceID": "19",
		"loginEventID": 183,
		"autoCallEnabled": false,
		"userID": 5,
		"branchID": 1,
		"counterID": 1,
		"userName": "User 1",
		"languageCode": "en-gb",
		"languageID": 1,
		"signOnTime": 1596528646137,
		"dispenserProfileID": 0,
		"customerDataID": 0,
		"selectedBranches": [],
		"roles": {
			"1": [
				3
			]
		},
		"jSessionID": "59498A0B3F99630E7336C2EA3B6534E4",
		"languages": [
			1
		]
	},
    "avatar": "/qnet6/files?name=user-photos/user_5.png",
    "branchTime": 20210415154216
}

Logout

User logout.

Request
POST /qnet6/rest/v2/counter/{wsid}/logout;jsessionid={{jsessionid}}
Request example
http://localhost:3000/qnet6/rest/v2/counter/counter1/logout;jsessionid={{jsessionid}}
Parameters
Name Type Description
wsid String Counter wsID
Request body
Key Type Description
code Number Closing code ID
Fields

No any field.

Response example
{}

Status change

Change user status.

Request
POST /qnet6/rest/v2/counter/{wsid}/status/{code};jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/status/1;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
code Number Status code ID

Request body

No request body.

Fields

No any field.

Response example

{}

Clear status

Clear user status.

Request

DELETE /qnet6/rest/v2/counter/{wsid}/status;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/status;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

No request body.

Fields

No any field.

Response example

{}

User configuration

Get user configuration.

Request

GET /qnet6/rest/v2/counter/{wsid}/config;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/config;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

No request body.

Fields

Key Type Description
autoCallMin Number Auto-call min time
autoCallMax Number Auto-call max time
autoTransStartTime Number Auto transaction start time
forcedCallMenuTimeout Number Forced call timeout
waitingClientLimit Number Waiting client limit in branch
notifyPopup Boolean Notification: Pop-up
notifySignal Boolean Notification: Audio signal
photo String User avatar url
logoutCode Boolean User have to send logout code (true/false)
multiClosingCode Boolean User can send more closing code (true/false)
closingCode Boolean User have to send closing code (true/false)
redirectStayHere Boolean After redirect stay transaction page
deleteTickets Boolean User-Role: Delete ticket (true/false)
useAfterWork Boolean User-Role: Afterwork (true/false)
forceAutocall Boolean User-Role: Forced auto call ticket (true/false)
hasDirectCall Boolean User-Role: Direct call ticket (true/false)
checkClerkReport Boolean User-Role: View clerk statistic (true/false)
useChat Boolean User-Role: Chat (true/false)
useAlarm Boolean User-Role: Use alarm sign (true/false)
checkWaitClientList Boolean User-Role: Check waiting clients list (true/false)
generateTicket Boolean User-Role: Generate ticket (true/false)
language Number User default language

Response example

{
	"autoCallMin": 1,
    "autoCallMax": 30,
    "autoTransStartTime": 30,
	"waitingClientLimit": 300,
    "notifyPopup": false,
    "notifySignal": false,
    "photo": "files?name=user-photos/user_5.png",
    "logoutCode": false,
    "multiClosingCode": false,
    "closingCode": false,
    "deleteTickets": true,
    "useAfterWork": true,
    "forceAutocall": false,
    "hasDirectCall": true,
    "checkClerkReport": true,
    "useChat": true,
    "useAlarm": true,
    "checkWaitClientList": true,
    "generateTicket": true,
	"language": 1
}

Save user configuration

Save user configuration.

Request

PUT /qnet6/rest/v2/counter/{wsid}/config;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/config;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

Key Type Description
autoCallMin Number Auto-call min time
autoCallMax Number Auto-call max time
autoTransStartTime Number Auto transaction start time
notifyPopup Boolean Notification: Pop-up
notifySignal Boolean Notification: Audio signal
language Number User default language

Fields

No any field.

Response example

{}

Get user chat messages

Get user chat messages.

Request

GET /qnet6/rest/v2/counter/{wsid}/chat;jsessionid={{jsessionid}}?partner={userID}&limit={limit}&offset={offset}&unRead={unread}&serverCount={serverCount}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/chat;jsessionid={{jsessionid}}?partner=6&limit=50&offset=0&unRead=true&serverCount=true

Parameters

Key Type Description
wsid String Counter wsID
partner Number User ID
limit Number Limit
offset Number Offset
unRead Boolean Readed or not
serverCount Boolean Received messages count on server or not

Request body

No requext body.

Fields

Key Type Description
count Number User received messages number (if serverCount is true)
messages Array Messages information in array
messages[].mesId Number Record ID
messages[].mesUsrId Number Sender user ID
messages[].mesUsrName String Sender user name
messages[].mesText String Message text
messages[].mesTime Number Message timestamp
messages[].reId Number Recipients ID
messages[].reUsrId Number Recipients user ID
messages[].reUsrName String Recipients user name
messages[].reReading String Readed or not (‘Y’-yes; ‘N’-No)

Response example

{
    "count": 2,
    "messages": [
        {
            "mesId": 1,
            "mesUsrId": 6,
            "mesUsrName": "User 2",
            "mesText": "Hi!",
            "mesTime": 20200916115904,
            "reId": 1,
            "reUsrId": 5,
            "reUsrName": "User 1",
            "reReading": "N"
        },
        {
            "mesId": 2,
            "mesUsrId": 6,
            "mesUsrName": "User 2",
            "mesText": "You're awesome!",
            "mesTime": 20200916115958,
            "reId": 2,
            "reUsrId": 5,
            "reUsrName": "User 1",
            "reReading": "N",
        }
    ]
}

Send user chat message

Send user chat message.

Request

POST /qnet6/rest/v2/counter/{wsid}/chat/{userID}/send;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/chat/5/send;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
userID Number User ID (recipient)

Request body

Key Type Description
message String User chat message text

Fields

No any field.

Response example

{}

Mark read user chat messages

Mark read user chat messages.

Request

PUT /qnet6/rest/v2/counter/{wsid}/chat/{userID}/markRead;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/chat/5/markRead;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
userID Number User ID (sender)

Request body

Key Type Description
lastID Number Last message ID

Fields

No any field.

Response example

{}

Alarm

There is active alarm or not.

Request

GET /qnet6/rest/v2/counter/{wsid}/alarm;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/alarm;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

No request body.

Fields

Key Type Description
default Number Default value (always 0)
value Number Actual value (1-active, 0-deactivate)
extra Number UserID when alarm is active

Response example

{
	"default" : 0,
	"value" : 1,
	"extra" : 5
}

Alarm start

Alarm start.

Request

POST /qnet6/rest/v2/counter/{wsid}/alarm/start;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/alarm/start;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

No request body.

Fields

No any field.

Response example

{}

Alarm stop

Alarm stop.

Request

POST /qnet6/rest/v2/counter/{wsid}/alarm/stop;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/alarm/stop;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

No request body.

Fields

No any field.

Response example

{}

Codes

The statistical codes: (1-ClosingCode, 2-LogoutCode, 3-StatusCode)

Request

GET /qnet6/rest/v2/counter/{wsid}/codes;jsessionid={{jsessionid}}?type={type}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/codes;jsessionid={{jsessionid}}?type=1

Parameters

Key Type Description
wsid String Counter wsID
type Number Code type (1-ClosingCode, 2-LogoutCode, 3-StatusCode, empty-all )

Request body

No request body.

Fields

Key Type Description
codId Number Code ID
type Number Code type (1-ClosingCode, 2-LogoutCode, 3-StatusCode)
codName String Code name
cdlName String Code name on user language

Response example

[
	{
		"codId": 11,
		"type" : 1,
		"codName": "Success",
		"cdlName": "Success"
	},
	{
		"codId": 12,
		"type" : 2,
		"codName": "Work out",
		"cdlName": "Work out"
	},
	{
		"codId": 13,
		"type" : 3,
		"codName": "Break",
		"cdlName": "Break"
	}
]

Services

Services list

Request

GET /qnet6/rest/v2/counter/{wsid}/services;jsessionid={{jsessionid}}?mode={mode}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/services;jsessionid={{jsessionid}}?mode=1

Parameters

Key Type Description
wsid String Counter wsID
mode Number Mode: 1-User can resolve; 2-User can not resolve

Request body

No request body.

Fields

Key Type Description
tskId Number Service ID
tskIdNum Number Service number
tskName Number Service name
tskServReq Number Required service time
tskServAvr Number Avr service time
tskCallWait Number Call delay(central settings)
btCallWait Number Call delay(branch settings)
tlName Number Service name in user language

Response example

[
	{
        "tskId": 1,
        "tskIdNum": 1,
        "tskName": "Service 1",
        "tskServReq": 6,
        "tskServAvr": 3,
        "tskCallWait": 0,
        "btCallWait": 0,
        "tlName": "Service 1"
    },
    {
        "tskIdNum": 2,
        "tlName": "Service 2",
        "tskId": 2,
        "tskName": "Service 2"
    }
]

Waiting ticket list

Get waiting tickets

Request

GET /qnet6/rest/v2/counter/{wsid}/waitingTickets;jsessionid={{jsessionid}}?onlyCount={onlyCount}&customData={customData}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/waitingTickets;jsessionid={{jsessionid}}?onlyCount=false&customData=1

Parameters

Key Type Description
wsid String Counter wsID
onlyCount Boolean Only count information(true) / all(false)
customData Number Customer data 1(true) / 0(false)

Request body

No request body.

Fields

Key Type Description
totalWaitingTicketsInBranch Number Waiting tickets in branch (counted)
waitingTicketsListCount Number Waiting tickets for user (counted)
ticketOnLocalWLCount Number Waiting tickets in user local wait list (counted)
ticketOnGlobalWLCount Number Waiting tickets in global wait list (counted)
waitingTicketsList Array Waiting tickets for user
waitingTicketsList[].atcId Number Ticket ID
waitingTicketsList[].atcNumber String Ticket number
waitingTicketsList[].atcPriority Number Ticket priority
waitingTicketsList[].atcTicketTime Number Ticket print time
waitingTicketsList[].atcStaTime Number Ticket last status changed time
waitingTicketsList[].attPriority Number Ticket task priority
waitingTicketsList[].attZeroTask String Ticket task is zero task(true) or not(false)
waitingTicketsList[].tskId Number Service ID
waitingTicketsList[].tskName String Service name
waitingTicketsList[].tlName String Service name on user language
waitingTicketsList[].clerk Number User ID (only redirected ticket)
waitingTicketsList[].counter Number Counter ID (only redirected ticket)
waitingTicketsList[].customerData Object Customer data
ticketOnLocalWL Array Waiting tickets in user local wait list
ticketOnLocalWL[].atcId Number Ticket ID
ticketOnLocalWL[].atcNumber String Ticket number
ticketOnLocalWL[].atcPriority Number Ticket priority
ticketOnLocalWL[].atcTicketTime Number Ticket print time
ticketOnLocalWL[].atcStaTime Number Ticket last status changed time
ticketOnLocalWL[].tskId Number Service ID
ticketOnLocalWL[].tskName String Service name
ticketOnLocalWL[].tlName String Service name on user language
ticketOnGlobalWL Array Waiting tickets in global wait list
ticketOnGlobalWL[].atcId Number Ticket ID
ticketOnGlobalWL[].atcNumber String Ticket number
ticketOnGlobalWL[].atcPriority Number Ticket priority
ticketOnGlobalWL[].atcTicketTime Number Ticket print time
ticketOnGlobalWL[].atcStaTime Number Ticket last status changed time
ticketOnGlobalWL[].tskId Number Service ID
ticketOnGlobalWL[].tskName String Service name
ticketOnGlobalWL[].tlName String Service name on user language
ticketCountByTasks Array Tickets by task
ticketCountByTasks[].tskId Number Service ID
ticketCountByTasks[].tskName String Service name
ticketCountByTasks[].tlName String Service name on user language

Response example

{
	"totalWaitingTicketsInBranch": 1,
	"waitingTicketsListCount": 1,
	"ticketOnLocalWLCount": 0,
	"ticketOnGlobalWLCount": 0,
	"waitingTicketsList": [
		{
			"atcId": 24,
			"atcNumber": "1",
			"atcPriority": 5,
			"atcTicketTime": 20200805093512,
			"atcStaTime": 20200805093512,
			"attPriority": 5,
			"attZeroTask": "N",
			"tskId": 1,
			"tskName": "Service 1",
			"tlName": "Service 1",
			"clerk": 5,
			"counter":1,
			"customerData": {
                "cusData02": "Teszt data 02",
                "cusData01": "Teszt data 01",
                "cusId": 1,
                "cus1Time": 20210510105334
            },
		}
	],
	"ticketOnLocalWL": [
		{
            "atcId": 15,
            "atcNumber": "4",
            "atcPriority": 5,
            "atcTicketTime": 20200916153406,
            "atcStaTime": 20200916153816,
			"tskId": 2,
            "tskName": "Service 2",
            "tlName": "Service 2",
        }
	],
	"ticketOnGlobalWL": [
		{
            "atcId": 16,
            "atcNumber": "5",
            "atcTicketTime": 20200916153406,
            "atcStaTime": 20200916153816,
            "atcPriority": 5,
			"tskId": 4,
            "tskName": "Service 4",
            "tlName": "Service 4"
        }
	],
	"ticketCountByTasks": [
		{
			"tskId": 1,
			"tskName": "Service 1",
			"tlName": "Service 1",
			"ticketCount": 1
		}
	]
}

Active users

Get logged in users list.

Request

GET /qnet6/rest/v2/counter/{wsid}/activeUsers;jsessionid={{jsessionid}}?ticketID={ticketID}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/activeUsers;jsessionid={{jsessionid}}?ticketID=1

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
auId Number Active user ID
usrId Number User ID
usrName String User name
cntId Number Counter ID
cntNumber String Counter number
cntDescript String Counter description
avatar String URL

Response example

 [
	{
		"auId": 44,
		"usrId": 6,
		"usrName": "User 2",
		"cntId": 2,
		"cntNumber": "2",
		"cntDescript": "Web counter 2"
	}
]

Generate ticket

Generate a new ticket with a choosen task(s).

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket;jsessionid={{jsessionid}}

Parameters

Name Type Description
wsid String Counter wsID

Request body

Key Type Description
service Number/Array Service ID
language Number Language ID / empty (use system default language)

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
			"atc1Time": 20200804075234,
			"atcType": 1,
			"atcNumber": "1",
			"atcSta": 30,
			"atcWaitSum": 37,
			"language": {
				"lngCode": "en-gb",
				"lngId": 1,
				"lngName": "English"
			},
			"atcPrint": "Y",
			"atcSelTask": 1,
			"atcWaitNum": 0,
			"atcWaitTime": 60,
			"atcCallNum": 0,
			"atcMTime": 20200804075311,
			"atcDelayed": "N",
			"atcTicketTime": 20200804075234,
			"tcId": 23,
			"atcPriority": 5,
			"tasks": [
				{
					"attWorkTime": 0,
					"attId": 23,
					"attSta": 20,
					"tskIdNum": 1,
					"attZeroTask": "N",
					"attAfterwork": "N",
					"tlName": "Service 1",
					"tskId": 1,
					"tskName": "Service 1"
				}
			]
	}
}

Delete ticket

Delete a ticket.

Request

DELETE /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID};jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/252;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

Key Type Description
comment String Ticket comment

Fields

No any field.

Response example

{}

Get customer data

Request

GET /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/customerData;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/252/customerData;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
cusId Number Customer data ID
cusInterface Number Customer data interface value
cusNew String Technikal data
cusUnident String Technikal data
cusIdent String Customer identification information
customerData Object Customer data client specific values (01-10)
customerPhotoBASE64 String Client photo in base64
customerPhotoRelativeURL String Client photo URL

Response example

{
	"cusId": 2,
	"cusInterface" : 121,
	"cusNew" : "Y",
	"cusUnident" : "Y",
	"cusIdent" : "cusIdent",
	"customerData": {
		"cusData01": "Teszt Name",
		"cusData02": "12312312123",
		"cusData03": "Some information",
		"cusData04": "Nice information",
		"cusData05": "123123452-1234123123",
		"cusData06": "Data 6",
		"cusData07": "Birtok u",
		"cusData08": "Budapest",
		"cusData09": "Data 9",
		"cusData10": "Hungary"
	},
	"customerPhotoBASE64":"image in base64",
	"customerPhotoRelativeURL": "styles/base/images/2.png"
}

Get users

Request

GET /qnet6/rest/v2/counter/{wsid}/users;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/users;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID

Request body

No request body.

Fields

Key Type Description
usrId Number User ID
usrName String User name
avatar String User photo url

Response example

[
    {
        "usrId": 5,
        "usrName": "User 1",
		"avatar": "/qnet6/files?name=user-photos/user_5.png"
    },
    {
        "usrId": 6,
        "usrName": "User 2",
		"avatar": "/qnet6/files?name=user-photos/user_6.png"
    },
    {
        "usrId": 7,
        "usrName": "User 3",
		"avatar": "/qnet6/files?name=user-photos/user_7.png"
    },
    {
        "usrId": 8,
        "usrName": "User 4",
		"avatar": "/qnet6/files?name=user-photos/user_8.png"
    },
    {
        "usrId": 9,
        "usrName": "User 5",
		"avatar": "/qnet6/files?name=user-photos/user_9.png"
    }
]

Save customer data

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/customerData;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/252/customerData;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

Key Type Description
cusId Number Customer data ID / empty (new)
cusInterface Number Customer data interface value
cusNew String Technikal data
cusUnident String Technikal data
cusIdent String Customer identification information
customerData Object Customer data client specific values (01-10)

Fields

Key Type Description
cusId Number Customer data ID
cusInterface Number Customer data interface value
cusNew String Technikal data
cusUnident String Technikal data
cusIdent String Customer identification information
customerData Object Customer data client specific values (01-10)
customerPhotoBASE64 String Client photo in base64
customerPhotoRelativeURL String Client photo URL

Response example

{
	"cusId": 2,
	"cusInterface" : 121,
	"cusNew" : "Y",
	"cusUnident" : "Y",
	"cusIdent" : "cusIdent",
	"customerData": {
		"cusData01": "Teszt Name",
		"cusData02": "12312312123",
		"cusData03": "Some information",
		"cusData04": "Nice information",
		"cusData05": "123123452-1234123123",
		"cusData06": "Data 6",
		"cusData07": "Birtok u",
		"cusData08": "Budapest",
		"cusData09": "Data 9",
		"cusData10": "Hungary"
	},
	"customerPhotoBASE64":"image in base64",
	"customerPhotoRelativeURL": "styles/base/images/2.png"
}

User statistics

Request

GET /qnet6/rest/v2/counter/{wsid}/statistic;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/statistic;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID

Request body

No request body.

Fields

Key Type Description
idleTime String Idle time sum
idleTimeActive String Idle time: acive
idleTimePassive String Idle time: passive
chartTask[] Array Service data for chart
chartHourly[] Array
sumWorktime String Work time sum
avgWorktime String Work time avg
transCount String Transactions count
loggedIn String Logged in time sum
hallOfFame[] Array Best users data
statusTimes[] Array
effRate1 String
effRate2 String

Response example

{
    "idleTimeActive": "0",
    "idleTimePassive": "0",
    "chartTask": [
        {
            "taskCount": 3,
            "tskId": 1,
            "tskName": "Service 1                                                                                           "
        },
        {
            "taskCount": 1,
            "tskId": 2,
            "tskName": "Service 2                                                                                           "
        },
        {
            "taskCount": 1,
            "tskId": 4,
            "tskName": "Service 4                                                                                           "
        },
        {
            "taskCount": 1,
            "tskId": 5,
            "tskName": "Service 5                                                                                           "
        },
        {
            "taskCount": 4,
            "tskId": 6,
            "tskName": "Service 6                                                                                           "
        }
    ],
    "sumWorktime": "2m 56s",
    "transCount": 10,
    "idleTime": "0",
    "hallOfFame": [
        {
            "usrId": 5,
            "usrName": "User 1",
            "transCount": 10
        },
        {
            "usrId": 6,
            "usrName": "User 2",
            "transCount": 1
        }
    ],
    "chartHourly": [
        {
            "countTrans": 10,
            "sttrHour": 11
        }
    ],
    "statusTimes": [],
    "avgWorktime": "17s",
    "loggedIn": "4m 14s",
    "effRate2": 0.0,
    "effRate1": 21.489001692047378
}

Redirect back data

Request

GET /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/redirectBackData;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/{ticketID}/redirectBackData;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
availableTasksByUsers Object Services for redirect back grouped by user ID
userTasks Object Services on ticket for users

Response example

{
    "availableTasksByUsers": {
        "6": [
            1,
            4,
            5,
            6
        ]
    },
    "userTasks": {
        "6": [
            2
        ]
    }
}

Voice recording

Request

GET /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/voiceRecording;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/{ticketID}/voiceRecording;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
running Object Voice recording stopped manual(false) or running (true)

Response example

{
    "running": true
}

Get messages

Request

GET /qnet6/rest/v2/counter/messages;jsessionid={{jsessionid}}?language={language}

Request example

http://localhost:3000/qnet6/rest/v2/counter/messages;jsessionid={{jsessionid}}?language={language}

Parameters

Key Type Description
language number Language ID (without: system default language)

Request body

No request body.

Fields

Key Type Description
messages Object Messages
language String LanguageCode

Response example

{
    "messages": {
        "4100": "Transaction",
        "4102": "Time",
        "4104": "Start",
        "8200": "Q-net Dashboard",
	},
	"language": "en",
	"customerData": {
        "data01Label": "Name",
        "data02Label": "Phone Number",
        "data03Label": "Customer data #3",
        "data04Label": "Customer data #4",
		"data05Label": "Account Number",
        "data06Label": "Customer data #6",
        "data07Label": "Address",
        "data08Label": "City",
        "data09Label": "Customer data #9",
        "data10Label": "Country"
	}
}

Get languages

Request

GET /qnet6/rest/v2/counter/{wsid}/languages;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/languages;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID

Request body

No request body.

Fields

Key Type Description
name String Language name
id Number LanguageID
code String LanguageCode

Response example

[
    {
        "name": "English",
        "id": 1,
        "code": "en-gb"
    },
    {
        "name": "Magyar",
        "id": 17,
        "code": "hu"
    }
]

Add comment to ticket

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/comment;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/252/comment;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

Key Type Description
comment String Comment to ticket

Fields

No any field.

Response example

{}

To zero task

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/zeroTask;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/252/task/456/zeroTask;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

No request body.

Fields

No any field.

Response example

{ }

Call next ticket

Request

POST /qnet6/rest/v2/counter/{wsid}/callNext;jsessionid={{jsessionid}}?service={service}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/callNext;jsessionid={{jsessionid}}?service=2

Parameters

Key Type Description
wsid String Counter wsID
service Number Service ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Call ticket

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/call;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/call;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Call ticket from list

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/callFromList;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/callFromList;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Recall ticket

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/recall;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/recall;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Start transaction

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/transaction/start;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/task/3/transaction/start;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

Key Type Description
autoStart Boolean Transaction start automatically

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Stop transaction

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/transaction/stop;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/task/3/transaction/stop;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

Key Type Description
closingCode Number/Array Closing code ID
realTransaction Boolean Was real transaction?!
needAfterwork Boolean Need afterwork?!

Fields

Key Type Description
result Number Result list
ticket Object Ticket information

Response example

{
	"result" : 1,
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Ticket redirect

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/redirect;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/redirect;jsessionid={{jsessionid}}

Request body example (redirect to counter ID 5)

{
	"type": "counter",
	"taskID": 123,
	"counter": 5,
	"realTransaction": true,
	"forced": false
}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

Key Type Description
type String Redirection type
realTransaction Boolean Was real transaction
closingCode Number/Array Closing code ID
taskID Number Ticket task ID
forced Boolean Forced redirect
service Number Service ID
clerk Number User ID
counter Number Counter ID
stayHere Boolean Ticket stay at the actual user
localList Boolean Ticket go to the local(true) / global(false) list

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Add task

Request

PUT /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/service/{serviceID};jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/service/1;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
serviceID Number Service ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Missing

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/missing;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/missing;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Start afterwork

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/afterwork/start;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/task/3/afterwork/start;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

No request body.

Fields

Key Type Description
ticket Object Ticket information

Response example

{
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

Stop afterwork

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/afterwork/stop;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/3/task/3/afterwork/stop;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

No request body.

Fields

Key Type Description
result Number Result list
ticket Object Ticket information

Response example

{
	"result" : 1,
	"ticket": {
		"atc1Time": 20200810081608,
		"atcCallNum": 0,
		"atcDelayed": "N",
		"atcId": 3,
		"atcMTime": 20200810144147,
		"atcNumber": "1",
		"atcPrint": "N",
		"atcPriority": 5,
		"atcSelTask": 1,
		"atcSta": 30,
		"atcStaTime": 20200810144147,
		"atcTicketTime": 20200810081608,
		"atcType": 2,
		"atcWaitSum": 0,
		"language": {
			"lngCode": "en-gb",
			"lngId": 1,
			"lngName": "English"
		},
		"tasks": [
			{
				"attWorkTime": 0,
				"utScale": 4,
				"attSta": 20,
				"tskIdNum": 2,
				"tlName": "Service 2",
				"tskName": "Service 2",
				"attId": 3,
				"attZeroTask": "N",
				"attAfterwork": "N",
				"tskId": 2
			}
		]
	}
}

User idletime

Request

POST /qnet6/rest/v2/counter/{wsid}/idletime;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/idletime;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID

Request body

Key Type Description
active Number Idletime: active
passive Number Idletime: passive

Fields

No any field.

Response example

{ }

Voice recording stop

Request

POST /qnet6/rest/v2/counter/{wsid}/ticket/{ticketID}/task/{ticketTaskID}/voiceRecording/stop;jsessionid={{jsessionid}}

Request example

http://localhost:3000/qnet6/rest/v2/counter/counter1/ticket/{ticketID}/task/{taskID}/voiceRecording/stop;jsessionid={{jsessionid}}

Parameters

Key Type Description
wsid String Counter wsID
ticketID Number Ticket ID
ticketTaskID Number Ticket task ID

Request body

No request body.

Fields

No any field.

Response example

{ }

Special objects

UserData

Name Type Description
userData.branchID Number Branch ID
userData.counterID Number Counter ID
userData.wsID String Counter websocet id
userData.clientID String Counter client id
userData.deviceID String Counter device id
userData.userID Number User ID
userData.userName String User name
userData.loginEventID Number Login event ID
userData.languageID Number Language ID
userData.languageCode String Language code
userData.signOnTime Number Login timestamp
userData.autoCallEnabled Boolean Auto ticket call
userData.dispenserProfileID Number Dispenser profile ID (only in dispenser)
userData.customerDataID Number Customer data ID (only in dispenser)
userData.selectedBranches Array Branch ID (only in administrator page)
userData.roles Object Roles in branches
userData.roles.1 String Branch ID
userData.roles.1.[] Number Role ID
userData.languages Array Language ID
userData.jSessionID String Session ID

Ticket

Name Type Description
ticket.tcId Number Ticket ID
ticket.atcNumber String Ticket number
ticket.atc1Time Number Ticket print time / created time
ticket.atcTicketTime Number Ticket print time / created time
ticket.atcMTime Number Ticket modified time
ticket.atcType Number Ticket type
ticket.atcSta Number Ticket status
ticket.atcSelTask Number Selected tasks count
ticket.atcPriority Number Ticket priority
ticket.atcPrint String Printed(‘Y’) or not(‘N’)
ticket.atcDelayed String Delayed(‘Y’) or not(‘N’)
ticket.atcWaitSum Number Ticket wait time sum
ticket.atcWaitNum Number Waiting customers before ticket
ticket.atcWaitTime Number Waiting time at ticket printing
ticket.atcCallNum Number Call count
ticket.language Object Language information
ticket.language.lngId Number Language ID
ticket.language.lngCode String Language code
ticket.language.lngName String Language name
ticket.tasks Array Task information
ticket.tasks[].attId Number TicketTask ID
ticket.tasks[].attSta Number TicketTask status
ticket.tasks[].tskId Number Task ID
ticket.tasks[].tskIdNum Number Task number for statistic
ticket.tasks[].tskName String Task name
ticket.tasks[].tlName String Task name in ticket language
ticket.tasks[].attZeroTask String Zero task(‘Y’) or not(‘N’)
ticket.tasks[].attAfterwork String Need afterwork(‘Y’) or not(‘N’)
ticket.tasks[].attWorkTime Number Transaction time
ticket.tasks[].att1ime Number TicketTask created time
ticket.tasks[].attMTime Number TicketTask modified time

CustomerData

Name Type Description
customerData.cusData01 String Customer data 01
customerData.cusData02 String Customer data 02
customerData.cusData03 String Customer data 03
customerData.cusData04 String Customer data 04
customerData.cusData05 String Customer data 05
customerData.cusData06 String Customer data 06
customerData.cusData07 String Customer data 07
customerData.cusData08 String Customer data 08
customerData.cusData09 String Customer data 09
customerData.cusData10 String Customer data 10
customerData.cus1Time Number Record created
customerData.cusMTime Number Record modified
customerData.cusId Number Record ID

Stop transaction results

Name Description
1 Ticket closed
2 No more service for this user, this ticket is active
3 There is also service on the ticket
4 No more service, but there has afterwork

Stop afterwork results

Name Description
1 Ticket closed
2 There is also afterwork on the ticket
3 No more afterwork for this user, this ticket is active

Redirect type matrix

Key/Type clerk counter task list back
type X X X X X
realTransaction X X X X X
forced X X X
closingCode Opt Opt Opt Opt
taskID (ticketTask) X X Opt Opt
stayHere X X
clerk X Opt Opt
counter X Opt
service X Opt
localList X

Legend:

Counter REST Appointment v2 REST
Last updated: Fri Jul 19 2024