Designer Properties

A designer is an entity that designs games. Often times it represents a company or a brand. Each designer has the following properties. Complete details in DesignerProperties.

id

The unique id for this designer. It will never change.

wing_object_type

designer

name

Another unique way of identifying a designer. However, this can be changed by an admin or the user that controls the designer.

user_id

A User id. The unique id of a user that has control over a designer, and therefore the games that the designer owns.

contact_email

An email address associated with this designer. This will be publicly available so people can contact the designer.

website_uri

A URI for the designer's public web site.

shop_uri

A URI for the designer's profile in the shop.

date_created

A date when the designer was created.

date_updated

A date when the designer was last updated.

logo_id

A File id. Sets the logo. The ID is from a File. If a logo_id is specified, then an extra property called logo will be added which will briefly describe the image.

Relationships

games

The list of Games that are controlled by this designer.

associates

The list of DesignerAssociates attached to this designer.

Related Objects

user

The User that controls this designer.

Designer Options

Provides a list of the options that can be used to fill out various fields when creating or updating a designer.

 GET /api/designer/_options

Returns:

 {
    "payout_via" : [...]
 }

NOTE: You can also get this data by adding _include_options=1 to the parameter list when fetching a designer.

Designer Methods

The methods used to fetch and manipulate designers.

Create Designer

 POST /api/designer
session_id

Required. The unique session id provided by a Session method.

name

Required.

user_id

Required.

contact_email

Optional.

website_uri

Optional.

logo_id

Optional.

payout_via

Optional.

paypal_email

Optional.

Returns:

 {
   "id" : "xxx",
   "name" : "Shawshank Games",
   ...
 }

Update Designer

 PUT /api/designer/xxx

See Create Designer for details.

Delete Designer

 DELETE /api/designer/xxx
session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch Designer

 GET /api/designer/xxx
session_id

Optional. The unique session id provided by a Session method.

_include_options

Optional. See "Options" in Intro and Designer Options above for details.

_include_relationships

Optional. See "Relationships" in Intro and Designer Relationships above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Shawshank Games",
   ...
 }

List All Designers

 GET /api/designer
session_id

Optional. The unique session id provided by a Session method.

Returns:

 {
   "pager" : { ... },
   "items" : [
     {
       "id" : "xxx",
       "name" : "Shawshank Games",
       ...
     },
     ...
   ]
 }

List Designer's Games

 GET /api/designer/xxx/games

Returns:

 {
   "pager" : { ... },
   "items" : [
     {
       "id" : "xxx",
       "name" : "Prison Break",
       ...
     },
     ...
   ]
 }
^ Back to Top ^