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:
clientId integer Id único del cliente. Ver getClients
clientTaxId string Código tributario del cliente. En el caso de un RUT chileno el formato es sin puntos y con guión (ej: 99999999-9)
contactTypeId integer Id único del tipo de contacto. Ver getContactTypes
orderBy integer 1: Email (por defecto); 2: Nombre; 3: Apellidos; 4: Cliente (nombre)
order string ASC o DESC (default)
resultsPerPage integer Número de resultados por solicitud. Por defecto = 50 (máximo 100)
page integer Página de resultados. Por defecto = 1

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"
    },
    {
      "id": "18321",
      "name": "Peter",
      "lastName": "Dinklage",
      "email": "tyrion@lannister.com",
      "position": null,
      "contactTypeId": "3",
      "contactTypeName": "Jefatura"
    }
  ]
}

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:
id integer Id único del contacto (requerido)

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"
}

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.
clientId integer Id único del cliente del contacto (requerido)
email string Email del contacto del cliente (requerido)
contactTypeId integer Id único del tipo de contacto del contacto
name string Nombre del contacto
lastName string Apellidos del contacto
position string Cargo del contacto
phone string Télefono del contacto

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."}'
 -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"
}

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:
orderBy integer 1: Id (por defecto); 2: Nombre
order string ASC o DESC (default)
resultsPerPage integer Número de resultados por solicitud. Por defecto = 50 (máximo 100)
page integer Página de resultados. Por defecto = 1

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"
    }
  ]
}