Logo Wocoexis

API Documentation

Starting

The use of this API is restricted to programmers and people with knowledge of RESTApi services. All of the functions implemented in this API are also available in the Web interface, so if you don’t have the technologic knowledge, you can do it by the website.

Client Email and token

To use our API, you will need an email and a token. You will only see this information in this page if you are logged with the main user of the company, do not share this information with anybody out of your organization.

Method of calling functions

Our API have a REST format, that means that it doesn’t matter the programming language you are using, the calls will be always with the next endpoint:

http://www.wocoexis.com/api/{module}/{method}

To this endpoint you will pass the incoming parameters. Our recommendation is that you always use POST method to call our endpoint, but also we support GET methods in our API.

Return values

All the calls with return the data of the response in a JSON, but also will return and http status code that you can check. There are three different codes depending of the type of response we are sending.

Return values
200 The request have process in the right way
400 Wrong request: there is something bad with your request
401 Not allowed, something wrong with your login data
500 Something is wrong in our server the we could not process your call at this time

Incoming parameters

In all the calls we recommend to send the incoming parameters with the POST method, but we also support GET method.

User methods

getAll

With this method you can get the list of all the users associated with the main user of the company

endPoint: http://www.wocoexis.com/api/users/getAll

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API

Return values

This method return a JSON with multiples registries, each one with this keys:
Name Desctiption
id Correspond to the ID of the user in our platform; you will need this ID in other cases
email Correspond to the email of the user
nombre Correspond to the name of the user
apellido Correspond to the lastname of the user
nick Correspond to the nickname of the user
nombrePantalla Correspond of how we show the user name on the screen

getByEmail

With this method you can get the data of a users associated with the main user of the company giving the email address

endPoint: http://www.wocoexis.com/api/users/getByEmail

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
email This correspond to the email of the user to get the data

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
id Correspond to the ID of the user in our platform; you will need this ID in other cases
email Correspond to the email of the user
nombre Correspond to the name of the user
apellido Correspond to the lastname of the user
nick Correspond to the nickname of the user
nombrePantalla Correspond of how we show the user name on the screen

get

With this method you can get the data of a users associated with the main user of the company giving the ID

endPoint: http://www.wocoexis.com/api/users/get

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the id of the user in our platform to get the data

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
id Correspond to the ID of the user in our platform; you will need this ID in other cases
email Correspond to the email of the user
nombre Correspond to the name of the user
apellido Correspond to the lastname of the user
nick Correspond to the nickname of the user
nombrePantalla Correspond of how we show the user name on the screen

delete

With this method you can complete delete the data of a users associated with the main user of the company giving the email address

endPoint: http://www.wocoexis.com/api/users/delete

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
email This correspond to the email of the user to delete the data

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
response Will have OK if everything was good

create

With this method you can update or create a new user associated with the main user of the company

endPoint: http://www.wocoexis.com/api/users/create

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
email This correspond to the email of the user that you want to create
name This correspond to the name of the user that you want to create
lastname This correspond to the lastname of the user that you want to create

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
userId If everything is OK, this is the ID of the user in our platform

Groups methods

getAll

With this method you can get the list of all the groups associated with the main user of the company

endPoint: http://www.wocoexis.com/api/groups/getAll

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API

Return values

This method return a JSON with multiples registries, each one with this keys:
Name Desctiption
id Correspond to the ID of the group in our platform; you will need this ID in other cases
name Correspond to the name of the group
description Correspond to the description of the group
groupId Correspond to the parent group ID in case of sub-groups

getSubgroups

With this method you can get the list of all the sub-groups of a group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/groups/getSubgroups

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the sub-groups

Return values

This method return a JSON with multiples registries, each one with this keys:
Name Desctiption
id Correspond to the ID of the group in our platform; you will need this ID in other cases
name Correspond to the name of the group
description Correspond to the description of the group
groupId Correspond to the parent group ID in case of sub-groups

get

With this method you can get the data of a group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/groups/get

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the data

Return values

This method return a JSON with single registry, with this keys:
Name Desctiption
id Correspond to the ID of the group in our platform; you will need this ID in other cases
name Correspond to the name of the group
description Correspond to the description of the group
groupId Correspond to the parent group ID in case of sub-groups

getByName

With this method you can get the data of a group associated with the main user of the company giving the name of the group

endPoint: http://www.wocoexis.com/api/groups/getByName

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
name This correspond to the group name that you want to get the data

Return values

This method in case of success return a JSON with single registry, with this keys:
Name Desctiption
id Correspond to the ID of the group in our platform; you will need this ID in other cases
name Correspond to the name of the group
description Correspond to the description of the group
groupId Correspond to the parent group ID in case of sub-groups

getUsers

With this method you can get a list of all the users of this group associated with the main user of the company giving the ID of the group

endPoint: http://www.wocoexis.com/api/groups/getUsers

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the user list

Return values

This method return a JSON with multiples registries, each one with this keys:
Name Desctiption
id Correspond to the ID of the user in our platform; you will need this ID in other cases
email Correspond to the email of the user
nombre Correspond to the name of the user
apellido Correspond to the lastname of the user
nick Correspond to the nickname of the user
nombrePantalla Correspond of how we show the user name on the screen

delete

With this method you can complete delete the data of a group associated with the main user of the company giving the ID of the group

endPoint: http://www.wocoexis.com/api/groups/delete

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the ID of the group to delete the data

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
response Will have OK if everything was good

create

With this method you can update or create a new group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/groups/create

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
name This correspond to the name of the group that you want to create
description This correspond to the description of the group that you want to create
groupId (Optional) This correspond to the parent group ID of the user that you want to create in case of a sub-group

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
groupId If everything is OK, this is the ID of the group in our platform

addUser

With this method you can add a user to a group giving the user and group ID

endPoint: http://www.wocoexis.com/api/groups/addUser

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
userId This correspond to the ID of the user to be added
groupId This correspond to the ID of the group where we goanna add the user

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
response Will have OK if everything was good

removeUser

With this method you can remove a user from a group giving the user and group ID

endPoint: http://www.wocoexis.com/api/groups/removeUser

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
userId This correspond to the ID of the user to be removed
groupId This correspond to the ID of the group where we goanna remove the user

Return values

This method return a JSON with a single registry, with this keys:
Name Desctiption
response Will have OK if everything was good

Reports

selection

With this method you can get the selection report of a group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/reports/selection

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the report

Return values

This method return a XLS (Excel) document with the required information

training

With this method you can get the training report of a group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/reports/training

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the report

Return values

This method return a XLS (Excel) document with the required information

team

With this method you can get the team report of a group associated with the main user of the company

endPoint: http://www.wocoexis.com/api/reports/team

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
id This correspond to the group ID that you want to get the report

Return values

This method return a XLS (Excel) document with the required information

userPdf

With this method you can get the personal report of a user associated with the main user of the company

endPoint: http://www.wocoexis.com/api/reports/userPdf

Incoming values

Name Desctiption
emailLogin This correspond to the email of the main user of the application
token This correspond to the token to get access to the API
email This correspond to the email of the user that you want to get the report

Return values

This method return a PDF document with the required information