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:
- O nome de usuário e a senha são combinadas em uma string "usuário:senha"
- A seqüência resultante literal é então codificado em Base64
- O método de autorização seguido da palavra "Basic" é, então, colocado antes da seqüência codificada.
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.
Nome | Descrição | Tipo | Informações adicionais |
---|---|---|---|
adId | Código de identificação do anúncio no Mercado Máquinas. | integer | Obrigató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 Returns the specifications of an Ad according to the identification code in the Mercado Máquinas.
Nome | Descrição | Tipo | Informações adicionais |
---|---|---|---|
Name | Nome único da especificação | string | |
Group | Grupo da especificação | string | |
Description | Descrição da especificação | string | |
DataType | Tipo de dados da especificação | string | |
IsRequired | É obrigatório? | boolean | |
UnitOfMeasurement | Unidade de medida da especificação | string | |
IsList | Indica se a especificação é uma lista com valores fixos | boolean | |
ListOfValues | Valores aceitos para a especificação quando é uma lista | string 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}]