Nomes

Os nomes serão utilizados para nossa pesquisa.

Campos

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome principal que será utilizado na pesquisa
nome_alternativo1	string	Não	Uma variação do nome principal, este nome pode conter abreviações, variações de sobrenomes, entre outros detalhes
nome_alternativo2	string	Não	Uma variação do nome principal, este nome pode conter abreviações, variações de sobrenomes, entre outros detalhes
oab	string	Não	O número da OAB do nome a ser pesquisado
estado_oab	string	Não	Sigla do estado da OAB do nome a ser pesquisado
estados	list	Sim	Uma lista contendo as siglas dos estados separados por vírgula
escritorio	int	Não	ID do escritório que este nome pertence
ativo	boolean	Não	Define nome como ativo (True) ou inativo (False)

Cadastro de Nomes

O cadastro de nomes será realizado por uma requisição POST enviando os campos obrigatórios e quando necessário os opcionais

Requisição

O formato da requisição deve ser:

curl -v -X POST \
        -H "Authorization: Token <token>" \
        "https://homologacao.ws.justicafacil.com.br/nome/" \
        --data "nome=<Nome>&estados=<Sigla>&estados=<Sigla>&escritorio=<ID do escritório>"

Os dados serão enviados segundo o dicionário:

data={
    nome: '<nome>',
    nome_alternativo1: '<nome_alternativo1>',
    nome_alternativo2: '<nome_alternativo2>',
    oab: '<oab>',
    estado_oab: '<estado_oab>',
    estados: ['sigla_estado1', 'sigla_estado2',...],
    escritorio: '<ID do escritório>',
}

Resposta

Em caso de sucesso a resposta será o nome criado em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Usuario</nome>
    <nome_alternativo1></nome_alternativo1>
    <nome_alternativo2></nome_alternativo2>
    <estado_oab></estado_oab>
    <estados>
        <list-item>
            <id>1</id>
            <nome>MG</nome>
        </list-item>
    </estados>
    <ativo>True</ativo>
    <oab></oab>
    <escritorio>1</escritorio>
</root>

Erros

Abaixo serão listados os possíveis erros com um HTTP Status 400

Nome em branco

<?xml version="1.0" encoding="utf-8"?>
<root>
    <nome>
        <list-item>Este campo não pode ser em branco.</list-item>
    </nome>
</root>

Caracteres inválidos

O cadastro de nome e nomes alternativos somente aceitará caracteres alfabéticos.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <nome>
        <list-item>O nome possui caracteres invalidos</list-item>
    </nome>
</root>

Nome deve ser composto

O webservice afim de evitar o envio de muitos acompanhamentos de homônimos, não aceita a inclusão de nomes simples. Todo nome ou nome alternativo deve conter ao menos duas palavras

<?xml version="1.0" encoding="utf-8"?>
<root>
    <nome>
        <list-item>O nome informado não é composto</list-item>
    </nome>
</root>

Nome muito curto

O webservice afim de evitar o envio de muitos acompanhamentos de homônimos, não aceita a inclusão de nomes muito curtos. A regra aplicada é o primeiro nome deve possuir três ou mais caracteres e o último nome deve conter dois ou mais caracteres. Nomes do meio podem conter somente um caractere.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <nome>
        <list-item>O nome é muito curto</list-item>
    </nome>
</root>

<?xml version="1.0" encoding="utf-8"?>
<root>
    <nome>
        <list-item>O último nome em nome é muito curto</list-item>
    </nome>
</root>

Estado não informado

É necessário no cadastro, informar ao menos um estado.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <estados>
        <list-item>Informe pelo menos um estado</list-item>
    </estados>
</root>

Estado inválido

Os campos estados e estado_oab devem conter a sigla correta do estado (MG, ES), qualquer outro valor causará a seguinte falha no cadastro do nome.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <estados>
        <list-item>Estado inválido</list-item>
    </estados>
</root>

Edição de nomes

Um nome cadastrado poderá ser editado por uma requisição PUT enviando os campos obrigatórios e informando o ID do nome que será editado

Requisição

O formato da requisição deve ser:

curl -v -X PUT \
        -H "Authorization: Token <token>" \
        "https://homologacao.ws.justicafacil.com.br/nome/<id>/" \
        --data "nome=Jose%20da%20Silva&estados=MG&ativo=True"

Os dados serão enviados segundo o dicionário:

data={
    nome: '<nome>',
    nome_alternativo1: '<nome_alternativo1>',
    nome_alternativo2: '<nome_alternativo2>',
    oab: '<oab>',
    estado_oab: '<estado_oab>',
    estados: ['sigla_estado1', 'sigla_estado2',...],
    escritorio: '<ID do escritório>',
    ativo: '<valor>',
}

Resposta

Em caso de sucesso a resposta será o nome criado em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Usuario</nome>
    <nome_alternativo1></nome_alternativo1>
    <nome_alternativo2></nome_alternativo2>
    <estado_oab></estado_oab>
    <estados>
        <list-item>
            <id>1</id>
            <nome>MG</nome>
        </list-item>
    </estados>
    <ativo>True</ativo>
    <oab></oab>
    <escritorio>1</escritorio>
</root>

Erros

Os erros na edição são os mesmo do cadastro.

Deletar um nome

Um nome poderá ser deletado da pesquisa por um requisição DELETE enviando o ID do nome que deve ser removido.

Requisição

O formato da requisição deve ser:

curl -v -X DELETE \
        -H "Authorization: Token <token>" \
        "https://homologacao.ws.justicafacil.com.br/nome/<id>/" \

Resposta

Em caso de sucesso será retornado uma resposta com HTTP Status 204.

Erros

Quando um ID de um nome inválido for infomado será retornado um HTTP Status 400 com XML.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <detail>Não encontrado.</detail>
</root>

Consulta de nomes

Os nomes inseridos poderão ser consultados. Para consultar um nome é necessário enviar uma requisição GET.

Consulta todos os nomes

Para receber a listagem de todos os nomes é necessário enviar uma requisição GET não informando nenhum ID de nome.

Requisição

O formato da requisição deve ser:

curl -v -X GET \
        -H "Authorization: Token <token>" \
        "https://homologacao.ws.justicafacil.com.br/nome/" \

Resposta

Em caso de sucesso a resposta será o nomes cadastrados em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <list-item>
        <id>1</id>
        <nome>Nome do Usuario</nome>
        <nome_alternativo1></nome_alternativo1>
        <nome_alternativo2></nome_alternativo2>
        <estado_oab></estado_oab>
        <estados>
            <list-item>
                <id>1</id>
                <nome>MG</nome>
            </list-item>
        </estados>
        <ativo>True</ativo>
        <oab></oab>
        <escritorio>1</escritorio>
    </list-item>
    <list-item>
        <id>2</id>
        <nome>Nome do Usuario</nome>
        <nome_alternativo1></nome_alternativo1>
        <nome_alternativo2></nome_alternativo2>
        <estado_oab></estado_oab>
        <estados>
            <list-item>
                <id>1</id>
                <nome>RS</nome>
            </list-item>
        </estados>
        <ativo>True</ativo>
        <oab></oab>
        <escritorio>1</escritorio>
    </list-item>
</root>

Caso não existam nomes a serem exibidos o resultado será:

<?xml version="1.0" encoding="utf-8"?>
<root></root>

Consulta de nomes por ID

Para consultar um nome específico é necessário enviar uma requisição GET informando o ID.

Requisição

O formato da requisição deve ser:

curl -v -X GET \
        -H "Authorization: Token <token>" \
        "https://homologacao.ws.justicafacil.com.br/nome/<id>/" \

Resposta

Em caso de sucesso a resposta será o nome consultado em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Usuario</nome>
    <nome_alternativo1></nome_alternativo1>
    <nome_alternativo2></nome_alternativo2>
    <estado_oab></estado_oab>
    <estados>
        <list-item>
            <id>1</id>
            <nome>RS</nome>
        </list-item>
    </estados>
    <ativo>True</ativo>
    <oab></oab>
    <escritorio>1</escritorio>
</root>

Erros

Caso não existam nomes a serem exibidos no ID informado o resultado HTTP Status 404 sem conteúdo.