Escritórios

Os escritórios serão utilizados para agrupar os nomes

Campos

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome do escritório
referencia	string	Não	Identificador customizado para auxiliar na implementação da integração
nome_responsavel	string	Não	Nome do responsável pelo escritório
estado	string	Não
cidade	string	Não
ativo	boolean	Não	Define escritório como ativo (True) ou inativo (False)

Cadastro de Escritórios

O cadastro de escritórios 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/escritorio/" \
        --data "nome=<nome do escritório>&email=<email do escritório>"

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

data = {
    nome: '<nome do escritório>',
    referencia: '<valor>',
    nome_responsavel: '<valor>',
    estado: '<valor>',
    cidade: '<valor>',
}

Resposta

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

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Escritório</nome>
    <referencia></referencia>
    <nome_responsavel></nome_responsavel>
    <estado></estado>
    <cidade></cidade>
    <ativo>True</ativo>
</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>

Edição de escritórios

Um escritório cadastrado poderá ser editado por uma requisição PUT enviando os campos obrigatórios e informando o ID do escritório 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/escritorio/<id>/" \
        --data "nome=<nome do escritório>&email=<email do escritório>&ativo=True"

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

data = {
    nome: '<nome do escritório>',
    referencia: '<valor>',
    nome_responsavel: '<valor>',
    estado: '<valor>',
    cidade: '<valor>',
    ativo: '<valor>',
}

Resposta

Em caso de sucesso a resposta será escritório editado em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Escritório</nome>
    <referencia></referencia>
    <nome_responsavel></nome_responsavel>
    <estado></estado>
    <cidade></cidade>
    <ativo>True</ativo>
</root>

Erros

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

Deletar um escritório

Um escritório poderá ser removido/desativado junto com seus nomes/advogados por um requisição DELETE enviando o ID do nome que deve ser removido.

A remoção do escritório no sistema é lógica, ou seja, o escritório será apenas desativado e nunca deletado completamente.

Requisição

O formato da requisição deve ser:

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

Resposta

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

Erros

Quando um ID de um escritório 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 escritórios

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

Consulta todos os escritórios

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

Requisição

O formato da requisição deve ser:

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

Resposta

Em caso de sucesso a resposta será uma lista de escritórios em formato XML com HTTP Status 200.

<?xml version="1.0" encoding="utf-8"?>
<root>
    <list-item>
        <id>1</id>
        <nome>Nome do Escritório</nome>
        <referencia></referencia>
        <nome_responsavel></nome_responsavel>
        <estado></estado>
        <cidade></cidade>
        <ativo>True</ativo>
    </list-item>
    <list-item>
        <id>2</id>
        <nome>Outro nome de Escritório</nome>
        <referencia></referencia>
        <nome_responsavel></nome_responsavel>
        <estado></estado>
        <cidade></cidade>
        <ativo>True</ativo>
    </list-item>
</root>

Caso não existam escritórios a serem exibidos o resultado será:

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

Consulta de escritórios por ID

Para consultar um escritório 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/escritorio/<id>/" \

Resposta

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

<?xml version="1.0" encoding="utf-8"?>
<root>
    <id>1</id>
    <nome>Nome do Escritório</nome>
    <referencia></referencia>
    <nome_responsavel></nome_responsavel>
    <estado></estado>
    <cidade></cidade>
    <ativo>True</ativo>
</root>

Erros

Caso não existam escritórios para serem exibidos no ID informado o resultado HTTP Status 404 sem conteúdo.