Objeto Contacto
Puedes hacer uso de la API para solicitar la información de uno o más contactos de tu empresa.
Método getContacts
Método para obtener una lista de contactos de la empresa de acuerdo a parámetros definidos.
Parámetro | Descripción | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | GET | |||||||||||||||||||||
URL | https://api.duemint.com/v1/getContacts<params> | |||||||||||||||||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué contactos se desea obtener. Los parametros posibles son:
|
A continuación se muestra un ejemplo usando el método getContacts de la API de Duemint.
METHOD GET curl "https://api.duemint.com/v1/getContacts?resultsPerPage=2" \ -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "records": { "totalRecords": 33, "items": 2, "page": 1, "pages": 17 }, "items": [ { "id": "14355", "name": "Robert", "lastName": "Downey Jr.", "email": "ironman@me.com", "position": null, "contactTypeId": "1", "contactTypeName": "Gerencia", "divisionsKeys": ["sucursal1"] }, { "id": "18321", "name": "Peter", "lastName": "Dinklage", "email": "tyrion@lannister.com", "position": null, "contactTypeId": "3", "contactTypeName": "Jefatura", "divisionsKeys": ["sucursal1"] } ] }
Método getContact
Método para obtener un pago específico.
Parámetro | Descripción | |||
---|---|---|---|---|
Método | GET | |||
URL | https://api.duemint.com/v1/getContact<params> | |||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué contacto se desea obtener. Los parametros posibles son:
|
A continuación se muestra un ejemplo usando el método getContact de la API de Duemint.
METHOD GET curl "https://api.duemint.com/v1/getContact?id=14355" \ -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "id": "14355", "name": "Robert", "lastName": "Downey Jr.", "email": "ironman@me.com", "position": null, "contactTypeId": "1", "contactTypeName": "Gerencia", "divisionsKeys": ["sucursal1"] }
Método getContactTypes
Método para obtener un lista de tipos de contacto. El id único de un tipo de contacto puede ser utilizado como parámetro en getContacts
Parámetro | Descripción | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | GET | ||||||||||||
URL | https://api.duemint.com/v1/getContactTypes<params> | ||||||||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué tags se desea obtener. Los parametros posibles son:
|
A continuación se muestra un ejemplo usando el método getContactTypes de la API de Duemint.
METHOD GET curl "https://api.duemint.com/v1/getContactTypes?orderBy=2&order=ASC" \ -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "records": { "totalRecords": 2, "items": 2, "page": 1, "pages": 1 }, "items": [ { "id": "5", "name": "Administrativo" }, { "id": "1", "name": "Gerencia" } ] }
Método createContact
Método para crear un Contacto.
Parámetro | Descripción | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | POST | ||||||||||||||||||||||||
URL | https://api.duemint.com/v1/createContact | ||||||||||||||||||||||||
Post Params |
Parametros a comunicar.
|
A continuación se muestra un ejemplo usando el método createContact de la API de Duemint.
METHOD POST curl "https://api.duemint.com/v1/createContact' -X POST \ -d '{"clientId":"54345","email":"ironman@me.com","contactTypeId":"1",name":"Robert","lastName":"Downey Jr.","divisionsKeys": ["sucursal1"]}' -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "id": "14355", "name": "Robert", "lastName": "Downey Jr.", "email": "ironman@me.com", "position": null, "contactTypeId": "1", "contactTypeName": "Gerencia", "divisionsKeys": ["sucursal1"] }
Método updateContact
Método para actualizar un Contacto.
Parámetro | Descripción | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | PUT | |||||||||||||||||||||||||||
URL | https://api.duemint.com/v1/updateContact | |||||||||||||||||||||||||||
Post Params |
Parametros a comunicar.
|
A continuación se muestra un ejemplo usando el método updateContact de la API de Duemint.
METHOD PUT curl "https://api.duemint.com/v1/updateContact' -X PUT \ -d '{"id":"14355","clientId":"54345","email":"ironman@me.com","contactTypeId":"1",name":"Robert","lastName":"Downey Jr.","divisionsKeys": ["sucursal1"]}' -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "id": "14355", "name": "Robert", "lastName": "Downey Jr.", "email": "ironman@me.com", "position": null, "contactTypeId": "1", "contactTypeName": "Gerencia", "divisionsKeys": ["sucursal1"] }
Método deleteContact
Método para eliminar un Contacto.
Parámetro | Descripción | |||
---|---|---|---|---|
Método | DELETE | |||
URL | https://api.duemint.com/v1/deleteContact | |||
Post Params |
Parametros a comunicar.
|
A continuación se muestra un ejemplo usando el método deleteContact de la API de Duemint.
METHOD DELETE curl "https://api.duemint.com/v1/deleteContact' -X DELETE \ -d '{"id":"14355"}' -H 'Authorization: Bearer <token>' -H 'Accept: application/json'
El resultado ejemplo para esta llamada se muestra a continuación:
{ "id": "14355", "msg": "Contacto eliminado.", }