GET v1/ad-models/{category}/{make}/{model}

Resource to check if the model (Category/Manufacturer/Model) informed exists in the Mercado Máquinas website.

Requires Authorization

To perform authorization, you must submit the authentication credentials using the HTTP Basic authorization header.
The authorization header is constructed as follows:

  1. The username and password are combined into a string "user:password"
  2. The resulting literal string is then encoded in Base64
  3. The authorization method followed by the word "Basic" is then placed before the coded sequence.
For example, if the user is 'Aladdin' and the password is 'open-sesame' then the header should be:
Authorization: Basic QWxhZGRpbjpvcGVuLXNlc2FtZQ==

Response Codes

  • OK (200)
  • Unauthorized (401)
  • NotFound (404)

Request Information

URL Parameters

The parameters must be in the request URL.

NameDescriptionTypeAdditional Information
CategoryMachine/Equipment CategorystringRequired
MakeMachine/Equipment ManufacturerstringRequired
ModelMachine/Equipment ModelstringRequired

Request body parameters

These parameters must be in the request Body.

Description not available.

Response Information

Resource Description

AdModelResponse array Returns a list of found models

NameDescriptionTypeAdditional Information
CategoryMachine/Equipment Categorystring
MakeMachine/Equipment Manufacturerstring
ModelMachine/Equipment Modelstring
StartYearStart Year of Machine/Equipment Modelinteger
EndYearEnd Year of Machine/Equipment Modelinteger

Response Formats

application/json, text/json

Notes:

  • In Json format, the parameter names follow the camelCase pattern, that is, they always start with lowercase letters.
{
  "category": "Escavadeira",
  "make": "Case",
  "model": "CX220",
  "startYear": 1996,
  "endYear": 2019
}

text/html

{"category":"Escavadeira","make":"Case","model":"CX220","startYear":1996,"endYear":2019}

application/xml, text/xml

<AdModelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Category>Escavadeira</Category>
  <Make>Case</Make>
  <Model>CX220</Model>
  <StartYear>1996</StartYear>
  <EndYear>2019</EndYear>
</AdModelResponse>