Consultar seleção e capacidade compartilhadas

GET

/v1/empresa/vigilancia

curl --request GET \
  --url https://api.cotejar.com.br/v1/empresa/vigilancia \
  --header 'Authorization: Bearer <token>'

• Produção

Exige catalogo:ler. O ETag protege alterações da seleção. Preferência preservada não comprova vigilância executada.

Autorizações

• bearerAuth

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

cadastrados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

selecionados

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

elegiveis

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

vagas

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

cobertura

obrigatório

string

Valores permitidos: indisponivel sem_selecao parcial integral capacidade_excedida

exige_selecao

obrigatório

boolean

modo

obrigatório

string

Valores permitidos: selecao todos

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

capacidade

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

direito_ativo

obrigatório

boolean

Exemplo

{
  "cadastrados": 0,
  "selecionados": 0,
  "elegiveis": 0,
  "vagas": 0,
  "cobertura": "indisponivel",
  "modo": "selecao",
  "versao": 0,
  "capacidade": 0
}

Cabeçalhos

ETag

string

Versão opaca do recurso, incluindo aspas. Preserve o valor completo ao enviar If-Match.

401

Response for status 401

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Response for status 403

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Response for status 404

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Response for status 422

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Response for status 429

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Response for status 503

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}