Organizations

Submit an organization text check

Changed on

Submit plain text or a supported file on behalf of an organization member. The organization is authorized by the group_token form field and the check is owned by the group member whose email is passed in author.

The token must start with G-, the group must be active, and author must already belong to the group. callback is stored with the check and called after processing by the group API integration.

post/api/org/text/check/

Request

  • Base URL
    https://plagiarismcheck.org
  • Auth
    none required

Request body application/x-www-form-urlencoded

group_tokenstring required

Organization group token. It must start with G- and identify an active group.

authorstring email required

Email address of the group member who owns the submitted check.

textstring required

Text content to check.

filenamestring

Optional filename to store with the text check.

custom_authorstring

Optional display name for the author in group reports.

callbackstring uri

Optional callback URL called after processing finishes.

course_idstring

Optional identifier of the LMS course the check belongs to, as your system knows it. Stored with the check and used wherever access is scoped by course.

course_namestring

Optional name of the LMS course the check belongs to. Stored with the check and shown in group reports.

assignment_namestring

Optional name of the assignment the check belongs to. Stored with the check and shown in group reports. Blank values are treated as absent, names are deduplicated server-side, and names longer than 255 characters are truncated. There is no matching assignment_id, so this names the assignment without identifying it — two assignments sharing a name are grouped together in statistics.

Example request

{
  "group_token": "G-HEfFiCHYWYx....",
  "author": "student@example.com",
  "text": "An application programming interface is a set of definitions and protocols for building and integrating application software. A clear API makes it easier for developers to connect software components and automate repeatable workflows.\n",
  "filename": "submission.txt",
  "custom_author": "Student Name",
  "callback": "https://example.com/plagcheck/callback",
  "course_id": "42",
  "course_name": "Introduction to Biology",
  "assignment_name": "Term paper"
}

Response

The organization text check was created successfully.

successboolean

Example response

{
  "success": true,
  "data": {
    "id": 15,
    "user_id": 24,
    "filename": "example.pdf",
    "created_at": 1516279363000,
    "updated_at": 1516279364000,
    "submitted_at": 1516279364000,
    "state": 3,
    "language": "en",
    "pages": 30,
    "words": 127,
    "group_id": 100,
    "custom_author": "Student Name",
    "report_id": 13,
    "ai_report_id": 15,
    "creator": {
      "id": 3132945,
      "name": "John Doe",
      "email": "student@example.com",
      "created_at": 1512638171000,
      "updated_at": 1512638171000,
      "allowed_languages": [
        "en"
      ],
      "balance_type": 1,
      "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
      "is_email_verification_needed": true
    },
    "report": {
      "id": 13,
      "created_at": "1643727471000",
      "source_count": 5,
      "percent": "28.57"
    },
    "ai_report": {
      "enabled": true,
      "id": 15,
      "status": 3,
      "percent": 50.5,
      "processed_percent": 70.25,
      "strong_percent": 40.25,
      "likely_percent": 30,
      "mark": 1,
      "comment": "Lorem ipsum dolor",
      "comment_author": {
        "id": 24,
        "name": "John Doe"
      },
      "type": 3,
      "words": 550,
      "pages": 2,
      "group_id": 100,
      "creator": {
        "id": 3132945,
        "name": "John Doe",
        "email": "student@example.com",
        "created_at": 1512638171000,
        "updated_at": 1512638171000,
        "allowed_languages": [
          "en"
        ],
        "balance_type": 1,
        "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
        "is_email_verification_needed": true
      },
      "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus molestie diam id lacus maximus, ac scelerisque neque suscipit. Pellentesque luctus elit cursus varius aliquam. Nam neque leo, cursus sit amet quam a, dignissim malesuada est. Sed efficitur finibus felis euismod mattis. Donec egestas nunc odio, vitae lacinia nunc pellentesque id. Etiam ornare nunc vel accumsan ullamcorper. Donec sed lacinia orci.\n",
      "chunks": [
        {
          "reliability": 1,
          "position": [
            100,
            200
          ]
        }
      ],
      "ignored_ranges": [
        {
          "id": 123,
          "start": 42,
          "end": 87,
          "filename": "assignment-template.docx",
          "ignore_assignment_template_id": 55
        }
      ]
    }
  }
}

Changes

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • breaking

      the /////// response's property format changed from email to no format for status

    • breaking

      the ////// response's property format changed from email to no format for status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status