Designs API to retrieve or modify designs

Available license codes:

license codelicense namemore information
bsdA permissive Free Software license that lets this work be widely shared with few restrictions.http://opensource.org/licenses/BSD-3-Clause
cc0All rights to this work are waived and you can use it however you please.http://creativecommons.org/publicdomain/zero/1.0
ccbyYou can adapt, share or use this work commercially as long as you attribute the creator.http://creativecommons.org/licenses/by/2.0
ccbyncndCommercial use is not allowed nor can you remix or change this work & you have to attribute the creator.http://creativecommons.org/licenses/by-nc-nd/3.0/deed.en_US
ccbyncsaCommercial use is not allowed, you must attribute the creator, you may remix this work and the remixed work should be made available under this license.http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US
ccbyndYou may use the work commercially but you can not adapt the work and must attribute the creator.http://creativecommons.org/licenses/by-nd/3.0/deed.en_US
ccbysaCommercial use is allowed, you must attribute the creator, you may remix this work and the remixed work should be made available under this license.http://creativecommons.org/licenses/by-sa/3.0/deed.en_US
commercialA commercial licensehttp://www.youmagine.com/todo
gplv3A free software license that requires that all work based on this must also be free software as in freely remixable and sharable by anyone under the same license but may be used commercially.http://www.gnu.org/licenses/gpl-3.0.html
lgplA free software license that lets you use this work even within your own proprietary work but your work must be available to use by others.https://www.gnu.org/licenses/lgpl.html

Supported Formats: json

GET /v1/designs/search Search for designs

Params

Param nameDescription
q
optional

Search term


Value:

Must be String
page
optional

the current page number when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter
limit
optional

the number of items per page when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter

Supported Formats

json

GET /v1/designs Load all published designs

Params

Param nameDescription
page
optional

the current page number when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter
limit
optional

the number of items per page when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter

Supported Formats

json

Examples

Request

GET /v1/designs?auth_token=Vk2K8eCXoe9sycMCs4zV&limit=3&page=2

Response

200
[
  {
    "id": 62,
    "name": "Voolia 62",
    "slug": "voolia-62",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>",
    "user_id": 105,
    "created_at": "2016-06-10T12:17:04.819+02:00",
    "updated_at": "2016-06-10T12:17:04.819+02:00",
    "primary_image_id": null,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 62,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "tags": [],
    "user": {
      "id": 105,
      "screen_name": "Judith 105"
    }
  },
  {
    "id": 61,
    "name": "Camido 61",
    "slug": "camido-61",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>\n\n<p>Duis consequat dui nec nisi volutpat eleifend. Donec ut dolor. Morbi vel lectus in quam fringilla rhoncus.</p>",
    "user_id": 104,
    "created_at": "2016-06-10T12:17:04.768+02:00",
    "updated_at": "2016-06-10T12:17:04.768+02:00",
    "primary_image_id": null,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 61,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "tags": [],
    "user": {
      "id": 104,
      "screen_name": "Susan 104"
    }
  },
  {
    "id": 60,
    "name": "Gigazoom 60",
    "slug": "gigazoom-60",
    "description": "",
    "user_id": 103,
    "created_at": "2016-06-10T12:17:04.690+02:00",
    "updated_at": "2016-06-10T12:17:04.690+02:00",
    "primary_image_id": null,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 60,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "tags": [],
    "user": {
      "id": 103,
      "screen_name": "Harry 103"
    }
  }
]

GET /v1/designs/:id Load a specific design by ID or slug

Supported Formats

json

Examples

Request

GET /v1/designs/livepath-96?auth_token=CAyMRJkp8XEfLpRyxZmq

Response

200
{
  "id": 96,
  "name": "Livepath 96",
  "slug": "livepath-96",
  "description": "",
  "user_id": 143,
  "created_at": "2016-06-10T12:17:07.706+02:00",
  "updated_at": "2016-06-10T12:17:07.706+02:00",
  "primary_image_id": null,
  "license": "gplv3",
  "state": "published",
  "design_category_id": 96,
  "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
  "last_trending_popularity": 0.0,
  "current_delta_popularity": 0.0,
  "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
  "documents_zip": {
    "url": null
  },
  "download_count": 0,
  "documents_download_count": 0,
  "tags": [],
  "user": {
    "id": 143,
    "screen_name": "Jacqueline 143"
  }
}

POST /v1/designs Create a new design

Params

Param nameDescription
design
required
Value:

Must be hash
design[name]
required

The name of the design


Value:

Must be string.


Metadata: 
Maximum length: 255
design[license]
optional

The license code for the design


Value:

Must be one of: ccbysa, ccbyncsa, ccbynd, ccbyncnd, gplv3, ccby, lgpl, bsd, cc0, commercial.
design[excerpt]
required

Excerpt of the design


Value:

Must be string.


Metadata: 
Maximum length: 300
design[description]
optional

Description of the model


Value:

Must be text/html.

Supported Formats

json

Examples

Request

POST /v1/designs
  • design[name] = Eimbee 98
  • design[description] = <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p> <p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p> <p>Duis consequat dui nec nisi volutpat eleifend. Donec ut dolor. Morbi vel lectus in quam fringilla rhoncus.</p> <p>Mauris enim leo, rhoncus sed, vestibulum sit amet, cursus id, turpis. Integer aliquet, massa id lobortis convallis, tortor risus dapibus augue, vel accumsan tellus nisi eu orci. Mauris lacinia sapien quis libero.</p>
  • design[license] = gplv3
  • design[excerpt] = Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.

Response

403
{
  "error": "You are not authorized to access this page."
}

PATCH /v1/designs/:id Update a design

PUT /v1/designs/:id Update a design

Params

Param nameDescription
design
required
Value:

Must be hash
design[name]
required

The name of the design


Value:

Must be string.


Metadata: 
Maximum length: 255
design[license]
optional

The license code for the design


Value:

Must be one of: ccbysa, ccbyncsa, ccbynd, ccbyncnd, gplv3, ccby, lgpl, bsd, cc0, commercial.
design[excerpt]
required

Excerpt of the design


Value:

Must be string.


Metadata: 
Maximum length: 300
design[description]
optional

Description of the model


Value:

Must be text/html.
design[primary_image_id]
optional

ID of the primary image for this model


Value:

Must be integer.

Supported Formats

json

Examples

Request

PUT /v1/designs/photobean-53?auth_token=p4MzSV_MsEtxDxeaNE3_
  • design[name] = Foobar

Response

403
{
  "error": "You are not authorized to access this page."
}

DELETE /v1/designs/:id Delete a single design

Supported Formats

json

Examples

Request

DELETE /v1/designs/wikivu-50?auth_token=ZcKVtA7ey_eonsz8mVkx

Response

403
{
  "error": "You are not authorized to access this page."
}