Bookmarks
Zqueue
Gestão Centralizada
Sistema de Gestão de Atendimento e de Filas de Espera
Manual de Utilização da web API
Ztech Technologies, lda
Rua da Assuncção, nº42´, 3ºandar fração 17
1100-044 Lisboa | Portugal www.ztech.pt
Zqueue - Gestão Centralizada
Confidencialidade
Todo o conteúdo do presente documento é propriedade da Ztech Technologies (Ztech) e
A Ztech assegura que todos os dados que servirão de base para o projecto serão tratados com a máxima
As partes comprometem-se a aplicar a mesma diligência na prestação da informação de outra parte que
O presente documento, em situação de contratação do projecto pelo Cliente à Ztech, o Cliente terá o
Caso o Cliente opte por não contratar à Mobbit os serviços propostos e do qual este documento faz parte
A Ztech reserva-se o direito de decidir em cada caso da forma que, a seu exclusivo critério, julgar mais
Index
Information concerning the creation of the document
Identificação Documento
History
Versão
Data
Alterações
Autor
1 Introduction
This API is based on the REST architecture, allowing the remote use of the Terminal functions whilst being platform
2 Responses
The services always respond with XML tags in the following format.
Response tag returns the method response
Urls tag links some usefull methods related to the current one.
3 Request headers
After the authentication, it is required the header "X-Mobbit-Contactline" which contains the session id in order to
It should be included in every request header except in the login.
4 Methods
4.1 user.login
Allows an external user to authenticate himself in the system.
Request method:
Request parameters:
username (User username)
Request returns:
If the user is properly logged into the system the following response will be given back:
The <session_id> tag is the code to be use with other methods.
After login, all method must have "X-Mobbit-Contactline" header and it value is <session_id> value.
If the login method fails it will return:
</response>
Use Example:
4.2 user.logout
Disconnects a user from the system.
Request method:
Request requisites:
login
Use Example:
Request returns:
If the success tag returns TRUE the user is disconnected
4.3 user.getAvailableServiceDesks
Returns all the available service desks to the session user.
Request method:
login
If the success tag returns TRUE the service desks will be listed like this
The <service_desks> tag will list each <desk> result which returns the specific<id> and <name> of each one.
Use Example:
4.4 user.assignServiceDesk
Assigns a service desk to the user.
Request method:
Request parameters:
id_service_desk (Service desk id)
Request requisites:
login
Request returns:
If successful
Use Example:
4.5 serviceDesk.getAvailableServices
Lists the available services to the user at the selected service desk.
If successful returns a list of available services, each containing the service id, service name, priority number,
Use Example:
4.6 service.getQueueLine
Lists the available services to the user at the selected service desk.
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns a list of the issued tickets in the service queue.
if there are no tickets in the queue the response will be
Use Example:
4.7 serviceDesk.suspend
Suspend the activity of the service desk.
If successful returns TRUE.
Use Example:
4.8 serviceDesk.suspendForInternalService
Suspend the activity of the service desk due to an internal service.
Request method:
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE.
Use Example:
4.9 serviceDesk.resumeSuspension
Resumes a suspended service desk.
Request method:
Suspension
Request returns:
If successful returns TRUE. Returns FALSE if the service desk is not suspended.
Use Example:
4.10 service.getSuspendedTickets
Get the service list of suspended tickets.
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the list of suspended tickets.
Use Example:
4.11 service.getFoldedTickets
Get the service list of folded tickets.
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the list of folded tickets.
4.12 service.issueTicketNow
Issues a ticket for the service and queues it.
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the issued ticket.
Use Example:
4.13 service.callTicketNow
Calls the next ticket in the list. If the queue list is empty, issues a new ticket and call it.
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the called ticket.
Use Example:
4.14 service.getRedirectionList
Get the services list where the specified service can redirect to
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successfull returns TRUE and the services where the current one can redirect to.
4.15 service.redirectTicket
Redirects a ticket to another service
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the new ticket.
Use Example:
4.16 ticket.addNotes
Adds notes to a specific ticket
Request method:
Request parameters:
id_ticket (Ticket id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the ticket.
Use Example:
4.17 service.getLastCalledTicket
Return the last ticket called
Request method:
Request parameters:
id_service (Service id)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the last called ticket for the specific service.
Use Example:
4.18 service.recallTicket
Recall a specific ticket
id_ticket (id_ticket)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the ticket.
Use Example:
4.19 service.suspendTicket
Suspends a specific ticket
Request method:
Request parameters:
id_ticket (id_ticket)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the suspended ticket.
Use Example:
4.20 service.foldTicket
Folds a specific ticket
Request method:
Request parameters:
id_ticket (id_ticket)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the folded ticket.
4.21 service.terminateTicket
Terminates a specific ticket
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the ticket.
Use Example:
4.22 service.callSuspendedTicket
Calls a specific suspended ticket
Request method:
Request parameters:
id_ticket (id_ticket)
Request returns:
If successful returns TRUE and the called ticket.
Use Example:
4.23 service.callFoldedTicket
Calls a specific folded ticket
Request parameters:
id_ticket (id_ticket)
Request requisites:
login
assignServiceDesk
Request returns:
If successful returns TRUE and the called ticket.
Use Example:
4.24 user.closeServiceDesk
Calls a specific folded ticket
Request method:
Request parameters:
id_ticket (id_ticket)
Request requisites:
login
assignServiceDesk
Request returns:
If successfull returns TRUE.
Use Example:
4.25 ticket.getTicket
Returns a specific ticket
Request method:
Request parameters:
id_ticket (id_ticket)
Request requisites:
login
If successful returns TRUE and the ticket.
Manual - Utilização da WEB API
5 Schema