CONTACTLINE v3 - Gestão Centralizada

Manual - Utilização da WEB API

Request returns:

If the user is properly logged into the system the following response will be given back: <response>

<success>TRUE</success> <session_id>u1e72srh1l9d094bta8h9fcrt0</session_id>

<user_id>11347</user_id>

<username>miguel</username> </response>

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>

<success>FALSE</success> <message>Username doesn't exist</message>

</response> 
where the <message> tag will point out the error that had occured

Use Example:

/Contactline/api/endpoint.php?method=user.login&username=Miguel&password=Miguel

4.2 user.logout

Disconnects a user from the system.

Request method:

/Contactline/api/endpoint.php?method=user.logout

Request requisites:

 login

Use Example:

/Contactline/api/endpoint.php?method=user.logout

Request returns:

If the success tag returns TRUE the user is disconnected <?xml version="1.0" encoding="UTF-8" ?> 
<response>

<success>TRUE</success>

<message>Disconnected</message>

<urls>

<login>http://localhost/Contactline_PT/api/endpoint.php?method=user.login</login>

</urls> </response>

4.3 user.getAvailableServiceDesks

Returns all the available service desks to the session user.

Request method:

/Contactline/api/endpoint.php?method=user.getAvailableServiceDesks Request requisites:

 login

Escrito por: Miguel Teixeira

Gestão de Projecto: Luís Palma

Versão 1.0

Página:

6 / 23

Assunto: Contactline v 3.0 WEB API