Contactos

As rotas aqui descritas permitem criar, editar e remover contactos dos clientes e fornecedores.

Consulta de contactos em um cliente/fornecedor

get
Path parameters
idintegerRequired

id of the contact of which to get the information

Responses
200
OK
application/json
get
GET /contacts/{id} HTTP/1.1
Host: <API_URL>
Accept: */*
200

OK

{
  "data": {
    "type": "contacs",
    "attributes": {
      "name": "Contacto 1",
      "phone_number": 221111111,
      "mobile_number": 931111111,
      "email": "example@gmail.com",
      "categories": "{others,management}",
      "contactable_id": 2,
      "contactable_type": "Customer | Supplier"
    }
  }
}

Criação de contactos de um cliente/fornecedor

post
Body
Responses
200
OK
application/json
post
POST /contacts HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "data": {
    "type": "contacs",
    "attributes": {
      "name": "Contacto 1",
      "phone_number": "221111111",
      "mobile_number": "931111111",
      "email": "example@gmail.com",
      "categories": "Indicar tipo de contacto, pode indicar 4 valores: others,management,comercial,finance,general. Sendo necessario passar da seguinte forma {others,management}",
      "contactable_id": 2,
      "contactable_type": "Customer | Supplier"
    }
  }
}
200

OK

{
  "data": {
    "type": "contacs",
    "attributes": {
      "name": "Contacto 1",
      "phone_number": 221111111,
      "mobile_number": 931111111,
      "email": "example@gmail.com",
      "categories": "{others,management}",
      "contactable_id": 2,
      "contactable_type": "Customer | Supplier"
    }
  }
}
curl -v -X POST \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Accept: application/json' \
     -H 'Authorization: Bearer <access_token>'
     -d '<payload JSON>'
     '<API_URL>/suppliers'

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth. O payload JSON a enviar contém a seguinte informação:

{
  "data": {
    "type": "contacts",                                             // [OBRIGATÓRIO]
    "attributes": {                                                 // [OBRIGATÓRIO] Os atributos do fornecedor
      "name": "Contacto 1",                                         // [OPCIONAL] Descrição da ficha de contacto
      "phone_number": "931111111",                                  // [OPCIONAL] Número de telemóvel
      "mobile_number": "221111111",                                 // [OPCIONAL] Número de telefone
      "email": "example@gmail.com",                                 // [OPCIONAL] Email
      "categories": "{other,finance}",                              // [OPCIONAL] Definir um tipo de contacto, que varia entre (Direção, Comercial, Financeiro, Geral, Outros) (management, comercial, finance, general, others)
      "contactable_id": 2,                                          // [OBRIGATÓRIO] Id do cliente ou do fornecedor
      "contactable_type": "Customer",                              // [OBRIGATÓRIO] Indicar quem é o dono do contacto cliente ou fornecedor (Customer ou Supplier)
    }
  }
}

Alteração de contactos de um cliente/fornecedor

patch
Path parameters
idintegerRequired

id of the contact of which to update

Body
Responses
200
OK
application/json
patch
PATCH /contacts/{id} HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "data": {
    "type": "contacs",
    "attributes": {
      "name": "Contacto 1",
      "phone_number": "221111111",
      "mobile_number": "931111111",
      "email": "example@gmail.com",
      "categories": "Indicar tipo de contacto, pode indicar 4 valores: others,management,comercial,finance,general. Sendo necessario passar da seguinte forma {others,management}",
      "contactable_id": 2,
      "contactable_type": "Customer | Supplier"
    }
  }
}
200

OK

{
  "data": {
    "type": "contacs",
    "attributes": {
      "name": "Contacto 1",
      "phone_number": 221111111,
      "mobile_number": 931111111,
      "email": "example@gmail.com",
      "categories": "{others,management}",
      "contactable_id": 2,
      "contactable_type": "Customer | Supplier"
    }
  }
}
curl -v -X PATCH \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Accept: application/json' \
     -H 'Authorization: Bearer <access_token>'
     -d '<payload JSON>'
     '<API_URL>/suppliers'

No pedido acima, o access_token é o token de acesso válido devolvido pelo serviço de OAuth. O payload JSON a enviar contém a seguinte informação:

{
  "data": {
    "type": "contacts",                                             // [OBRIGATÓRIO]
    "attributes": {                                                 // [OBRIGATÓRIO] Os atributos do fornecedor
      "name": "Contacto 1",                                         // [OPCIONAL] Descrição da ficha de contacto
      "phone_number": "931111111",                                  // [OPCIONAL] Número de telemóvel
      "mobile_number": "221111111",                                 // [OPCIONAL] Número de telefone
      "email": "example@gmail.com",                                 // [OPCIONAL] Email
      "categories": "{other,finance}",                              // [OPCIONAL] Definir um tipo de contacto, que varia entre (Direção, Comercial, Financeiro, Geral, Outros) (management, comercial, finance, general, others)
      "contactable_id": 2,                                          // [OBRIGATÓRIO] Id do cliente ou do fornecedor
      "contactable_type": "Customer",                               // [OBRIGATÓRIO] Indicar quem é o dono do contacto cliente ou fornecedor (Customer ou Supplier)
    }
  }
}

Eliminação de contactos de um cliente/fornecedor

delete
Path parameters
idintegerRequired

id of the contact of which to remove

Responses
200
OK
delete
DELETE /contacts/{id} HTTP/1.1
Host: <API_URL>
Accept: */*
200

OK

No content

PreviousFornecedoresNextMoradas

Last updated