OneRoster

Get OneRoster sync configuration

Return the OneRoster sync configuration record for the given group. The authenticated user must be an owner of the group.

When no configuration has been saved yet, data is returned with all fields set to null.

get/api/v1/groups/oneroster-sync-data/{id}/

Request

  • Base URL
    https://plagiarismcheck.org
  • Auth
    API key in header X-API-TOKEN

Response

The request succeeded and returned the OneRoster sync configuration for the group.

successboolean

Example response

{
  "success": true,
  "data": {
    "id": 7,
    "status": 3,
    "url": "ftps://user:password@ftp.example.com/oneroster/",
    "last_synced_at": 1716800000
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.