Árvore de páginas

Objetivo

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

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/AtributoFixo

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

Parâmetros URI (URI Parameters)

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

TipoAtributoFixo

Tipo do atributo

string

Obrigatório.
ListaListastringNão há.
DescricaoDescrição do atributostringNã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

{

  "tipoAtributoFixo": "string",

   "lista": [
        {
            "valor": "string",
            "descricao": "string"
        }
    ]

}

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