Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Método de consulta que retorna informações de uma lista de segmentos.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/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)
Id

NroSegmento

Número de segmento

integer($int32)

Não há.

Descricao

Descrição do segmento

string

Não há.
StatusStatusstring(A = Ativos, I = Inativos, T = Todos)
NroDivisaoNúmero da divisãointeger($int32)Não há.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

...

application/json, text/json

CODE 200 - SUCCESS

 {
  "hasNext": true,
  "items": [
    {
        "

Id

NroSegmento": 0,

        "Descricao": "string",

        "status": "string"

        "idDivisao": 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
    }
  ]
}