Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de empresas.

Chamada

GET​/api​/v1​/Empresas

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
IdIdIntegerNão há
IdMatrizIdMatrizIntegerNão há
IdEmpresaMaeIdEmpresaMaeIntegerNão há
RazaoSocialRazaoSocialStringNão há
NomeReduzidoNomeReduzidoStringNão há
CnpjCnpjStringNão há
StatusStatusStringNão há
FieldsFieldsStringNão há
OrderOrderStringNão há
PagePageIntegerNão há
PageSizePageSizeIntegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Código (Code)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
200SuccessNão háNão há

Formatos de Resposta (Response Formats)

application/json, text/json 

{
  "hasNext": true,
  "items": [
    {
      "id": 0,
      "idMatriz": 0,
      "idEmpresaMae": 0,
      "razaoSocial": "string",
      "nomeReduzido": "string",
      "cnpj": "string",
      "status": "string",
      "expandables": [
        "string"
      ]
    }
  ]
}


Código (Code)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
400Bad RequestNão háNão há


application/json, text/json 

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}