Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta que retorna informações de uma lista de empresas por segmento.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Empresa/empresa-segmento

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

NroEmpresa

Número de empresa

integer($int64)

Não há.
NroSegmentoNúmero de segmentointeger($int64)Não há.
StatusStatus da empresastringOpções: A - Ativo, I - Inativo, T - Todos
FieldsCampos a serem listadosstringNão há.
OrderCampo a ser ordenadostringNão há.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "nroEmpresa": 0,
      "nomeReduzido": "string",
      "nroDivisao": 0,
      "status": "string",
      "nroSegmentoPrincipal": 0,
      "codigoPessoa": 0
    }
  ]
}

application/json, text/json

CODE 400 - BAD


{
  "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
    }
  ]
}


  • Sem rótulos