PolyCode API (1.0)

Download OpenAPI specification:Download

Do awesome stuff with PolyCode API

Application

Get the health of the application

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"status": "ok"
}
}

User

Find all users

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination
order-by	string Example: order-by=points:null,username:null Available keys: points, username
username	any Filter results by username (matching)

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
},
"order-by": {"keys": {"points": "asc",
"username": "asc"
}
},
"filter": {"keys": {"username": "string"
},
"arrays": { }
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"description": "string",
"points": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}

Find a user by id

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"description": "string",
"points": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}

Update a user

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Request Body schema: application/json

username	string The username of the user. Must be unique. Must be at least 3 characters long.
description	string The description of the user.

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"description": "string",
"points": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}

Get user's teams

Returns the user's teams

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0
},
"data": [{"id": "string"
}
]
}

Get all emails for a user

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"email": "user@example.com",
"isVerified": true
}
]
}

Create a new email

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Request Body schema: application/json

email

required

string <email>

The email of the user. Must be unique. Must be a valid email address.

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

201

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"email": "user@example.com",
"isVerified": true
}
}

Delete an email

Authorizations:

bearer

path Parameters

emailId required	string <uuid> The uuid of the email
userId required	any <uuid> The uuid of the user

Responses

Validate an email

path Parameters

verificationToken

required

string <uuid>

Token used to verify email.

Responses

Regenerate a verification token for an email and resend an email

path Parameters

emailId

required

string <uuid>

The uuid of the email

Responses

Get settings for an user

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"preferredEditingLanguage": "python",
"preferredLanguage": "fr"
}
}

Update settings for a user

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Request Body schema: application/json

preferredEditingLanguage	string Default: "javascript" The programming language that should be used by default for this user.
preferredLanguage	string Default: "en" Enum: "en" "fr" The human language that should be used by default for this user.

Responses

Request samples

Payload

Content type

application/json

{"preferredEditingLanguage": "python",
"preferredLanguage": "fr"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"preferredEditingLanguage": "python",
"preferredLanguage": "fr"
}
}

Reset user settings

Authorizations:

bearer

path Parameters

userId

required

any <uuid>

The uuid of the user

Responses

Response samples

default

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"preferredEditingLanguage": "python",
"preferredLanguage": "fr"
}
}

Item

Get all items

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination
order-by	string Example: order-by=cost:null Available keys: cost
type	string Enum: "hint" "validator" Filter results by type

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
},
"order-by": {"keys": {"cost": "asc"
}
},
"filter": {"keys": {"type": "hint"
},
"arrays": { }
}
},
"data": [{"id": "string",
"cost": 0,
"type": "hint",
"data": {"text": "string"
}
}
]
}

Get an item by id

Authorizations:

bearer

path Parameters

id

required

string <uuid>

The id of the item

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "string",
"cost": 0,
"type": "hint",
"data": {"text": "string"
}
}
}

Buy an item

Buy an item, decrement the user's points by the item's cost & returns the item. It wont decrement points if already bought

Authorizations:

bearer

path Parameters

id

required

string <uuid>

The id of the item

Responses

Response samples

201

Content type

application/json

{"metadata": { },
"data": {"id": "string",
"cost": 0,
"type": "string",
"data": {"text": "string"
}
}
}

Returns an item

Returns the item with data if the item was bought, without data otherwise

Authorizations:

bearer

path Parameters

id

required

string <uuid>

The id of the item

Responses

Transactions

Get all transactions

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
}
},
"data": [{"id": 0,
"object_id": "string"
}
]
}

Module

Find all modules

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination
order-by	string Example: order-by=name:null,reward:null Available keys: name, reward
name	any Filter results by name (matching)
authorId	any Filter results by authorId
type	any Filter results by type (matching)
tags	any Filter results by tags. Must be enclosed in square brackets, and be separated by commas

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
},
"order-by": {"keys": {"name": "asc",
"reward": "asc"
}
},
"filter": {"keys": {"name": "string",
"authorId": "string",
"type": "string"
},
"arrays": {"tags": "string"
}
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"type": "string",
"reward": 0,
"tags": ["string"
],
"data": { },
"modules": [{ }
],
"contents": [{ }
]
}
]
}

Find a module by id

Authorizations:

bearer

path Parameters

moduleId

required

string <uuid>

The uuid of the module

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"type": "string",
"reward": 0,
"tags": ["string"
],
"data": { },
"modules": [{ }
],
"contents": [{ }
]
}
}

Content

Find all contents

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination
order-by	string Example: order-by=name:null,reward:null Available keys: name, reward
name	any Filter results by name (matching)

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
},
"order-by": {"keys": {"name": "asc",
"reward": "asc"
}
},
"filter": {"keys": {"name": "string"
},
"arrays": { }
}
},
"data": [{"name": "string",
"description": "string",
"type": "exercise",
"reward": 0,
"rootComponent": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "container",
"data": { }
},
"data": {"allowedDuration": 0,
"internalName": "string",
"duplicatedFrom": "string"
}
}
]
}

Find a content by id

Authorizations:

bearer

path Parameters

contentId

required

string <uuid>

The UUID of the content

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"name": "string",
"description": "string",
"type": "exercise",
"reward": 0,
"rootComponent": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "container",
"data": { }
},
"data": {"allowedDuration": 0,
"internalName": "string",
"duplicatedFrom": "string"
}
}
}

Team

Create a new team

Authorizations:

bearer

Request Body schema: application/json

name required	string The name of the team. Must be unique. Must be at least 3 characters long. Must be less than 20 characters long.
description	string The description of the team. Must be less than 255 characters long.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
}

Find all teams

Authorizations:

bearer

query Parameters

page	number Page number for pagination
limit	number Number of item per page for pagination
order-by	string Example: order-by=name:null Available keys: name
name	any Filter results by name (matching)

Responses

Response samples

200

Content type

application/json

{"metadata": {"count": 0,
"pagination": {"page": 0,
"limit": 0,
"total": 0
},
"order-by": {"keys": {"name": "asc"
}
},
"filter": {"keys": {"name": "string"
},
"arrays": { }
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
]
}

Find a team by id

Authorizations:

bearer

path Parameters

teamId

required

string <uuid>

The uuid of the team

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
}

Update a team

Authorizations:

bearer

path Parameters

teamId

required

any <uuid>

The uuid of the team

Request Body schema: application/json

name	string The name of the team. Must be unique. Must be at least 3 characters long. Must be less than 20 characters long.
description	string The description of the team. Must be less than 255 characters long.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
}

Delete a team

Authorizations:

bearer

path Parameters

teamId

required

string <uuid>

The uuid of the team

Responses

Add a member to a team.

Authorizations:

bearer

path Parameters

teamId

required

string

Request Body schema: application/json

userId

required

string <uuid>

The userId of the user to add to the team

Responses

Request samples

Payload

Content type

application/json

{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

201

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
}

Remove a member from a team.

Authorizations:

bearer

path Parameters

teamId

required

string

Request Body schema: application/json

userId

required

string <uuid>

The id of the user to add to the team

Responses

Request samples

Payload

Content type

application/json

{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"members": [{"id": "string",
"username": "string",
"role": "captain"
}
]
}
}

Submission

Get last attempt and last success

Get best and last attempts if the user has completed the component

Authorizations:

bearer

path Parameters

componentId

required

string

Responses

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"lastSuccess": {"at": "string",
"data": {"language": "string",
"version": "string",
"code": "string"
}
},
"lastAttempt": {"at": "string",
"data": {"language": "string",
"version": "string",
"code": "string"
}
}
}
}

Submit a code

Submit a code, calls a runner to execute it and check the result with the validators of the component

Authorizations:

bearer

Request Body schema: application/json

componentId required	string The uuid of the component
language required	string The used programming language
code required	string Code to execute

Responses

Request samples

Payload

Content type

application/json

{"componentId": "string",
"language": "string",
"code": "string"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"success": true,
"validators": {"uuid": "string",
"success": true
}
}
}

Submit a code and test it with one validator

Submit a code, calls a runner to execute it and check the result with the validator

Authorizations:

bearer

path Parameters

validatorId

required

string

Request Body schema: application/json

language required	string The used programming language
code required	string Code to execute

Responses

Request samples

Payload

Content type

application/json

{"language": "string",
"code": "string"
}

Response samples

200

Content type

application/json

{"metadata": { },
"data": {"success": true,
"codeResult": {"stdout": "string",
"stderr": "string",
"exitCode": true
}
}
}