GET yacht/list

REST Apis

List of ads

Returns the list of ads placed with major data.

Resource URL

http://api.yacht4web.com/1.0/yacht/list

Parameters

appId

necessary

 Your App id
offset

Optional

 The starting line number of the query (default 1)
If you have many ads can be convenient to read in several calls indicating every time the request offset

Optional

 You can further refine your search by adding the filter parameters or common selection, such as having only the sailboats or only used boats.

Request example

http://api.yacht4web.com/1.0/yacht/list?appid=[appId]

Example of Result

{
   "offset":1,
   "limit":3,
   "res":[
      {
         "id":27534,
         "code":"MX00338",
         "manShipyard":"Princess yachts",
         "manModel":"Princess v78",
         "yearBuild":2009,
         "bitShare":3,
         "created_at":"2015-04-22T16:58:54+02:00",
         "updated_at":"2015-05-08T18:10:08+02:00"
      },
      {
         "id":27346,
         "code":"MX00336",
         "manShipyard":"Otam",
         "manModel":"Millenium 80",
         "yearBuild":2011,
         "bitShare":3,
         "created_at":"2015-04-17T16:50:48+02:00",
         "updated_at":"2015-04-27T22:20:08+02:00"
      },
      {
         "id":27345,
         "code":"MX00335",
         "manShipyard":"Otam",
         "manModel":"Millenium 55",
         "yearBuild":0,
         "bitShare":3,
         "created_at":"2015-04-17T15:49:23+02:00",
         "updated_at":"2015-05-07T22:00:09+02:00"
      }
   ]
}

Field guide

Field Type Description
offset Integer Indicates the offset of 1: default result varies depending on the request.
limit Integer Indicates the row limit with which the result was requested: default (if not indicated) 500.
RES array of ads Array of elements of type ads

Ads Object

Field Type Description
ID Int64 The whole represents the unique identifier of an ad.
code String The string is the indersione code for the customer
manShipyard String The Shipyard
manModel String the model
yearBuild Integer The year of construction. Can be 0
published Integer È a value that indicates where the advertisement was published:
0-not published
1-Posted on yacht4web
2-Posted on my site
3-Published on both sites
created_at String Ad creation date
updated_at String Last modified date in the format