Workplaces

Overview

MiTrabajoWS provides you with a RESTful API for performing CRUD operations on your workplaces. The supported actions are the following: index, view, create, update, delete and options. When appropriate, the header Content-Type: application/json should be included.

Index workplaces

GET /workplaces

Takes no parameters. Returns a list of all of your workplaces.

View workplace

GET /workplaces/<id>

Returns detailed information about the workplace identified by <id>.

Create workplace

POST /workplaces

Creates a new workplace from the JSON data sent in the body of the HTTP request. The format and fields of the workplace details can be found here.

Update workplace

PATCH /workplaces/<id>

PUT /workplaces/<id>

Updates the information about the workplace identified by <id>.

Delete workplace

DELETE /workplaces/<id>

Deletes the workplace identified by <id>.

Options

OPTIONS /workplaces

OPTIONS /workplaces/<id>

Retrieves the supported verbs for the specified endpoint.

Fields

name

Required, must be a string with at most 100 characters.

details

String.

status

Must be one of the following: 'Active', 'On Hold', 'Completed', 'Dropped', 'Dia Franco', 'Domicilio Particular'.

country

Required, must be an integer representing the country ID.

city

Must be a string with at most 100 characters.

address

String.

door_number

Must be a string with at most 6 characters.

floor

Integer.

apartment

Must be a string with at most 6 characters.

neighborhood

Must be a string with at most 100 characters.

lng, lat

Numbers representing coordinates.

olson

Must be a string with at most 200 characters.

phone

Must be a string with at most 50 characters.

centro_costo

Must be a string with at most 50 characters.

auxiliar

Must be a string with at most 50 characters.

postal_code

Must be a string with at most 10 characters.

id_externo

Integer.

id_grupo

Integer.