Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable Project Template

Examples

POST /api/project_templates
{
  "template": {
    "name": "Madiga"
  }
}
201

Params

Param name Description
template
optional

Template attributes container

Validations:

  • Must be a Hash

template[name]
optional

The name of template

Validations:

  • Must be a String

template[description]
optional

The description of template

Validations:

  • Must be a String

template[instructions]
optional

The instructions of template

Validations:

  • Must be a String

template[language]
optional

The language of template

Validations:

  • Must be a String

template[professions]
optional

The professions(topics) of template

Validations:

  • Must be an array of any type

template[difficulty_level]
optional

Difficult level of template.

Validations:

  • Must be a Integer

template[price_amount]
optional

Price in Cent

Validations:

  • Must be a Integer

template[price_currency]
optional

Price currency code

Validations:

  • Must be a String

template[ready_to_use]
optional

Ready to use

Validations:

  • Must be a Boolean

template[details]
required

Template details attributes container

Validations:

  • Must be an Array of nested elements

template[details][html_type]
optional

Validations:

  • Must be a String

template[details][instruction]
optional

Validations:

  • Must be a String

template[details][read_only]
optional

Validations:

  • Must be a Boolean

template[details][locked]
optional

Validations:

  • Must be a Boolean

template[details][rules]
required

Detail rules attributes container

Validations:

  • Must be an Array of nested elements

template[details][rules][type]
required

The type of rule. Available types are: word_count,character_count,main_keyword,sub_keyword,alternative_keywords,pixel_size,list_item,negative_keywords

Validations:

  • Must be a String

template[details][rules][parameters]
required

Rule parameters attributes container

Validations:

  • Must be an Array of nested elements

template[details][rules][parameters][name]
required

The name of parameter. Available parameters are: minimum,maximum,repetition,location,match,index,indexes,current,keyword,keywords,height,width,list_type,current_width,min_width,max_width,current_height,min_height,max_height

Validations:

  • Must be a String

template[details][rules][parameters][value]
required

Parameter value

Validations:

  • Must be a String

template[details][custom_attributes]
optional

custom attributes of item

Validations:

  • Must be an array of any type