Cadastro de contato

De RBX ISP - Manual do Usuário
Revisão de 07h59min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é criar um novo contato. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "contact_create": { "person_type...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é criar um novo contato. Abaixo, segue exemplo do json de envio:

{
  "contact_create":
  {
    "person_type": "C", 
    "person_id": 154,
    "name": "Carlos Silva",
    "complement": 10,
    "email": "joaozinho",
    "phone_1": "4433221155",
    "phone_2": "",
    "phone_3": "",
    "birthday": "1989-12-20",
    "type": "G",
    "status": "A"
  }
}

Detalhamento dos campos

<tbody> </tbody>
ID Campo Obrigatório Pai Tipo Observações
A01 Dados da autenticação Sim Raiz -  
A02 person_type Sim A01 Texto

Tipo de contato. Valores permitidos:

  • C: cliente
  • P: mercado
A03 person_id Sim A01 Número

Código do cliente/mercado.

A04 name Sim A01 Texto

Nome do contato

A05 complement Não A01 Texto

Código interno do tipo de complemento de contato.

A06 email Não A01 Texto

E-mail do contato

A07 phone_1 Não A01 Texto

Telefone do contato com ddd, apenas números.

A08 phone_2 Não A01 Texto

Telefone do contato com ddd, apenas números.

A09 phone_3 Não A01 Texto

Telefone do contato com ddd, apenas números.

A10 birthday Não A01 Data

Data de nascimento do contato no padrão AAAA-MM-DD

A11 type Sim A01 Texto

Tipo de contato. Valores permitidos:

  • G: geral
  • A: Administrativo
  • T:Técnico
A12 status Sim A01 Texto

Situação do contato. Valores permitidos:

  • A: Ativo
  • I: Inativo

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result":
    {
       "id": 22
    }
}

O campo id se refere ao código interno do contato cadastrado.

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 12,
  "error_description": "The field status is invalid!",
  "result": ""
}