GET v1/ads/{adid}/specs

Retorna as Especificações de um anúncio através do código informado

Requer Autorização

Para realizar a autorização, é necessário enviar as credenciais de autenticação usando o cabeçalho de autorização.
O cabeçalho de autorização é construído como se segue:

  1. O nome de usuário e a senha são combinadas em uma string "usuário:senha"
  2. A seqüência resultante literal é então codificado em Base64
  3. O método de autorização seguido da palavra "Basic" é, então, colocado antes da seqüência codificada.
Por exemplo, se o usuário é 'Aladdin' e a senha é "abra-de-sésamo" então o cabeçalho deve ser:
Authorization: Basic QWxhZGRpbjphYnJhLWRlLXPDqXNhbW8=

Códigos de Resposta

  • OK (200)
  • BadRequest (400)
  • Unauthorized (401)
  • Forbidden (403)
  • NotFound (404)

Informações da Requisição

Parâmetros da URL

Os parâmetros devem ser informados na URL da requisição.

NomeDescriçãoTipoInformações adicionais
adIdCódigo de identificação do anúncio no Mercado Máquinas.integerObrigatório

Parâmetros do corpo da requisição

Estes parâmetros devem ser informados no corpo da requisição.

Descrição não disponível.

Informações da Resposta

Descrição do recurso

AdSpecResponse array Retorna as Especificações de um anúncio de acordo com o código de identificação no Mercado Máquinas.

NomeDescriçãoTipoInformações adicionais
NameNome único da especificaçãostring
GroupGrupo da especificaçãostring
DescriptionDescrição da especificaçãostring
DataTypeTipo de dados da especificaçãostring
IsRequiredÉ obrigatório?boolean
UnitOfMeasurementUnidade de medida da especificaçãostring
IsListIndica se a especificação é uma lista com valores fixosboolean
ListOfValuesValores aceitos para a especificação quando é uma listastring array

Formatos da Resposta

application/json, text/json

Observações:

  • No formato Json, os nomes dos parâmetros seguem o padrão camelCase, ou seja, sempre são iniciados com letras minúsculas.
[
  {
    "name": "numero-de-serie",
    "group": "Informações Gerais",
    "description": "Número de série é o código que identifica máquinas, peças e acessórios e obter informações adicionais no fabricante.",
    "dataType": "text",
    "isRequired": false,
    "unitOfMeasurement": null,
    "isList": false,
    "listOfValues": null
  },
  {
    "name": "cor-predominante",
    "group": "Informações Gerais",
    "description": "Informar a cor predominante do equipamento.",
    "dataType": "text",
    "isRequired": false,
    "unitOfMeasurement": null,
    "isList": true,
    "listOfValues": [
      "amarelo",
      "azul",
      "indefinida",
      "laranja",
      "marron"
    ]
  },
  {
    "name": "utilizacao-horas",
    "group": "Utilização",
    "description": "Quantidade de horas completas trabalhadas. (Ex.: 2.350,8 horas digite apenas 2350)",
    "dataType": "number",
    "isRequired": true,
    "unitOfMeasurement": "h",
    "isList": false,
    "listOfValues": null
  }
]

text/html

[{"name":"numero-de-serie","group":"Informações Gerais","description":"Número de série é o código que identifica máquinas, peças e acessórios e obter informações adicionais no fabricante.","dataType":"text","isRequired":false,"unitOfMeasurement":null,"isList":false,"listOfValues":null},{"name":"cor-predominante","group":"Informações Gerais","description":"Informar a cor predominante do equipamento.","dataType":"text","isRequired":false,"unitOfMeasurement":null,"isList":true,"listOfValues":["amarelo","azul","indefinida","laranja","marron"]},{"name":"utilizacao-horas","group":"Utilização","description":"Quantidade de horas completas trabalhadas. (Ex.: 2.350,8 horas digite apenas 2350)","dataType":"number","isRequired":true,"unitOfMeasurement":"h","isList":false,"listOfValues":null}]