CP Judge API documentation

/users

post get

post
get

Returns list of users.

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

  • Content-Type: required (string)

    "application/json"

Body

Media type: application/json

Type: object

Example:

{
  "username": "tourist",
  "name": {
    "firstName": "Mahim",
    "lastName": "Agrawal"
  },
  "bio": "Guy in IT"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "oAuthToken": "{oAuthToken}"
}

get put delete

get

Returns details of user

put

Updates the details of the user

delete

"To delete a user with {userId}"

Returns details of user

URI Parameters

  • userId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "username": "tourist",
  "name": {
    "firstName": "Mahim",
    "lastName": "Agarwal"
  },
  "userId": 1,
  "bio": "Guy in IT",
  "rating": "Pro",
  "subId": [2,3],
  "quesId": [4,5]
}

Updates the details of the user

URI Parameters

  • userId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "username": "tourist",
  "name": {
    "firstName": "Mahim",
    "lastName": "Agarwal"
  },
  "bio": "Guy in IT"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "username": "tourist",
  "name": {
    "firstName": "Mahim",
    "lastName": "Agarwal"
  },
  "userId": 1,
  "bio": "Guy in IT",
  "rating": "Boo",
  "submissionId": [2,3],
  "contestId": [4,5]
}

"To delete a user with {userId}"

URI Parameters

  • userId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "commit" : "success"
}

/submissions

post get

post
get

Returns list of submissions

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "userId": 123,
  "questionId": 2,
  "code": "print('Hello world')",
  "status": "Accepted"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "submissionId": 0,
  "userId": 123,
  "questionId": 2,
  "code": "print('Hello world')",
  "status": "Accepted"
}

get

get

"Returns details of Submission : {submissionId}"

"Returns details of Submission : {submissionId}"

URI Parameters

  • submissionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "submissionId": "{submissionId}",
  "userId": 123,
  "questionId": 0,
  "code": "print('Hello world')",
  "status": "Accepted"
}

/organizations

post get

post
get

Returns list of users.

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

  • Content-Type: required (string)

    "application/json"

Body

Media type: application/json

Type: object

Example:

{
  "name": "Organization Name"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "commit": "success"
}

get put delete

get

Returns details of organization

put

Updates the details of the user

delete

"To delete a orgnanization with {organiztionId}"

Returns details of organization

URI Parameters

  • organiztionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "name": "Google",
  "organiztionId": 1,
  "contestId": [1,2,3]
}

Updates the details of the user

URI Parameters

  • organiztionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "name": "{New Name}"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "name": "{New Name}",
  "organiztionId": 1,
  "contestId": [1,2,3]
}

"To delete a orgnanization with {organiztionId}"

URI Parameters

  • organiztionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "commit" : "success"
}

/questions

post get

post
get

"Returns list of questions"

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "question": "Code for bubble sort",
  "editorial": "Blah blah blah",
  "testCases": "Some test cases"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "questionId": 0,
  "question": "Code for bubble sort",
  "editorial": "Blah blah blah",
  "testCases": "Some test cases",
  "submissionId": [2,3,4]
}

get put delete

get

"Returns details of Question : {questionId}"

put

"Modify details of Question : {questionId} All fields are optional "

delete

"To delete a question with {questionId}"

"Returns details of Question : {questionId}"

URI Parameters

  • questionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "questionId": 1,
  "question": "Code for selection sort",
  "editorial": "Blah blah blah",
  "testCases": "Some test cases",
  "submissionId": [5,6,7]
}

"Modify details of Question : {questionId} All fields are optional "

URI Parameters

  • questionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "question": "Code for selection sort",
  "editorial": "Blah blah blah",
  "testCases": "Some test cases"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "questionId": 1,
  "question": "Code for selection sort",
  "editorial": "Blah blah blah",
  "testCases": "Some test cases",
  "submissionId": [5,6,7]
}

"To delete a question with {questionId}"

URI Parameters

  • questionId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "commit" : "success"
}

/contests

post get

post
get

"Returns list of contests"

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "name" : "Contest name",
  "organizationId": 1
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "contestId": 1,
  "organizationId": 1,
  "name" : "Contest name",
  "leaderboard": "leaderboard",
  "questionId": [1,3,2],
  "userId": [0,2,3]
}

get put delete

get

"Returns details of Contest : {contestId}"

put

"Modify details of Contest : {contestId} All fields are optional "

delete

"To delete a user with {contestId}"

"Returns details of Contest : {contestId}"

URI Parameters

  • contestId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "contestId": 1,
  "organizationId": 1,
  "name" : "Contest name",
  "leaderboard": "leaderboard",
  "questionId": [1,3,2],
  "userId": [0,2,3]
}

"Modify details of Contest : {contestId} All fields are optional "

URI Parameters

  • contestId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

Body

Media type: application/json

Type: object

Example:

{
  "name" : "New Contest name"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "contestId": 1,
  "organizationId": 1,
  "name" : "New Contest name",
  "leaderboard": "leaderboard",
  "questionId": [1,3,2],
  "userId": [0,2,3]
}

"To delete a user with {contestId}"

URI Parameters

  • contestId: required (string)

Headers

  • Authorization: required (string)

    "A valid oAuthToken"

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "commit" : "success"
}