Project2s

Supported Formats

json
>>>

GET /api/project2s
Lists projects for the session user.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.

Params

Param name Description
filter_type
optional

For specific project listing

Validations:

  • Must be a String
filter
optional

comma separated filter to apply e.g. “admin_list,status:running”

Validations:

  • Must be a Hash
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
status
required

Status of projects

Validations:

  • Must be a String
extended_version
optional

Validations:

  • Must be one of: true, false.
>>>

GET /api/project2s/:id
Shows project details.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.

Params

Param name Description
id
optional

Project ID

Validations:

  • Must be a String
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
>>>

POST /api/project2s
Creates new project.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
422 Unprocessable Project2.

Params

Param name Description
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
>>>

DELETE /api/project2s/:id
Delete project

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found
422 Unprocessable Project2.

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:id/statistics
Project statistics

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
>>>

GET /api/project2s/:id/export
Exports project's content orders in given format such as xml,json, csv or markdown

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Examples

GET /api/project2s/59c241e8a83dc1219d4f3249/export.xml
200
<?xml version="1.0" encoding="UTF-8"?>
<project id="59c241e8a83dc1219d4f3249">
</project>

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:id/copy
Copies Project2

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found
422 Unprocessable Project2.

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
>>>

PUT /api/project2s/:id
Update Project

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String
project
optional

Project parameter container

Validations:

  • Must be a Hash
project[name]
optional

Project name

Validations:

  • Must be a String
project[account_id]
optional

Account ID

Validations:

  • Must be a String
project[default_template_id]
optional

Default template ID

Validations:

  • Must be a String
project[status]
optional

running, paused, archived

Validations:

  • Must be a String
project[public]
optional

not private

Validations:

  • Must be a Hash
project[max_in_progress]
optional

Maximum number of tasks allowed to be in progress

Validations:

  • Must be a Integer
project[plagiarism_percentage]
optional

Plagiarism Percentage

Validations:

  • Must be a Integer
project[spellchecker]
optional

Spellchecker name

Validations:

  • Must be a String
project[rule_check_for]
optional

Rule check for :writer, :editor, :client, :manager

Validations:

  • Must be an array of any type
project[time_frame]
optional

Sets for minimum time between tasks

Validations:

  • Must be a Hash
>>>

PUT /api/project2s/:id/available_task
Update Project available task per person

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
external_id
required

Task external Id

Validations:

  • Must be a String
amount
required

amount

Validations:

  • Must be a Integer
>>>

GET /api/project2s/:id/available_tasks
Get all available task per persons of Project

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:id/change_account
Change account of project

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found
422 Unprocessable Project2.

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
account_id
required

New account id

Validations:

  • Must be a String
>>>

POST /api/project2s/confirm_upload_duplicates
Confirming of upload duplicates

This route confirms duplicate cases of uploading content orders

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
upload_id
required

Upload Id

Validations:

  • Must be a String
confirmations
required

Duplicate items confirmation data

Validations:

  • Must be an array of any type
>>>

PUT /api/project2s/:id/upload_content_orders
Upload Content Orders

This route uploads content orders to given project id.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String
file
required

File that includes orders as tsv format

Validations:

  • Must be a String
>>>

POST /api/project2s/upload_content_text
Upload Content Orders Text

This route uploads content orders without a project id in the route. Project id should be in the tsv text.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
text
required

Text that includes orders in TSV format

Validations:

  • Must be a String
>>>

PUT /api/project2s/upload_content_orders
Upload Content Orders

This route uploads content orders without a project id in the route. Project id should be in tsv file.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
file
required

File that includes orders as tsv format

Validations:

  • Must be a String
>>>

POST /api/project2s/:id/block_user
Blocks user for specific roles

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Validations:

  • Must be a String
user_id
required

Validations:

  • Must be a String
roles
required

Validations:

  • Must be one of: writer, editor.
reasons
required

Validations:

  • Must be an array of any type
message
required

Validations:

  • Must be a String
>>>

POST /api/project2s/:id/unblock_user
Unblocks user for specific roles or for all roles

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Validations:

  • Must be a String
user_id
required

Validations:

  • Must be a String
roles
required

Roles to unblock

Validations:

  • Must be one of: writer, editor.
>>>

GET /api/project2s/:id/blocked_users
Returns blocked user list

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Validations:

  • Must be a String