Orgão

POST /v1/orgao/

Adiciona um orgão

Headers:

Authorization token

Payload:

{
  "o_leg_id": 2456,
  "orgao": "Olinda, PE",
}

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "oid": "{oid}"
    }
  }
}

Retorno:

201 | 400 | 406

GET /v1/orgao/search/{needle}/{offset}/{limit}/

Lista e pequisa os Órgãos existentes na base de dados, de forma paginada

Headers:

Authorization token

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "orgaos": [
        {
          "oid": "{16-byte-hex}",
          "orgao": "Olinda, PE",
          "o_leg_id": 99
        }
      ],
      "total": 10,
      "next": false
    }
  }
}

Retorno:

200 | 400 | 404 | 406

GET /v1/orgao/{oid}/

Lista os dados de um Órgão específico

Headers:

Authorization token

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "oid": "{16-byte-hex}",
      "orgao": "Olinda, PE",
      "o_leg_id": 99
    }
  }
}

Retorno:

200 | 400 | 404 | 406

PUT /v1/orgao/{oid}/

Altera um orgão

Headers:

Authorization token

Payload:

{
    "o_leg_id": 2456,
    "orgao": "Olinda, PE",
}

Response: (Empty)

Retorno:

200 | 400 | 405 | 406 | 409

Entidade

POST /v1/entidade/

Adiciona um orgão

Headers:

Authorization token

Payload:

{
    "oid": "{oid}",
    "o_e_leg_id": 2456,
    "orgao_entidade_tipo": 1,
    "cnpj": "12345678910123",
    "fantasia": "Nome fantasia",
    "razao_social": "Razao Social",
    "data_fundacao": "YYYY-mm-dd"
}

Response:

{
    "success": true,
    "data": {
	"GovernancaAPI": {
	    "oeid": "{oeid}"
	}
    }
}

Retorno:

201 | 400 | 406

GET /v1/entidade/search/{needle}/{offset}/{limit}/

Lista e pequisa as entidades existentes na base de dados, de forma paginada

Headers:

Authorization token

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "entidades": [
        {
          "oid": "{16-byte-hex}",
          "oeid": "{16-byte-hex}",
          "o_e_leg_id": 199,
          "orgao_entidade_tipo": 1,
          "cnpj": "12345678910123",
          "fantasia": "Nome fantasia",
          "razao_social": "Razao Social",
          "data_fundacao": "YYYY-mm-dd"
        }
      ],
      "total": 10,
      "next": false
    }
  }
}

Retorno:

200 | 400 | 404 | 406

GET /v1/entidade/{oeid}/

Lista os dados de uma Entidade específico

Headers:

Authorization token

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "oid": "{16-byte-hex}",
      "o_e_leg_id": 199,
      "orgao_entidade_tipo": 1,
      "cnpj": "12345678910123",
      "fantasia": "Nome fantasia",
      "razao_social": "Razao Social",
      "data_fundacao": "YYYY-mm-dd"
    }
  }
}

Retorno:

200 | 400 | 404 | 406

PUT /v1/entidade/{oeid}/

Altera uma entidade

Headers:

Authorization token

Payload:

{
    "cnpj": "12345678910123",
    "fantasia": "Nome fantasia",
    "razao_social": "Razao Social",
    "data_fundacao": "YYYY-mm-dd"
}

Retorno:

200 | 400 | 406

POST /v1/orgao-entidade-id/

Exchange para listar os orgaos e entidades

• Retornar 400 se os campos orgaos e entidades estiverem vazios
• Retornar 404 se nenhum orgao e entidade for encontrado

Headers:

Authorization token

Payload:

{
    "orgaos": ["{oid}"],
    "entidades": ["{oeid}"],
}

Response:

{
  "success": true,
  "data": {
    "GovernancaAPI": {
      "orgaos": [
        {
          "oid": "3a95c3e244e390e7ca8ced6d3abc0b",
          "orgao": "Lagoa do Carro, PE"
        }
      ],
      "entidades": [
        {
          "oeid": "5e95767f1ac55f81c5c4dd9ae210e3",
          "nome": "Prefeitura Municipal de Lagoa do Carro",  // mesmo que razão social
          "tipo": "Prefeitura",
          "pessoa_juridica": {
            "razao_social": "Prefeitura Municipal de Lagoa do Carro",
            "fantasia": "Prefeitura Municipal de Lagoa do Carro",
            "cnpj": "40893778000191",
            "fundacao": "1900-01-01"
          }
        }
      ]
    }
  }
}

Retorno:

200 | 400 | 404