Provisions multiple types of data in a single call.

curl --request POST \
  --url https://api.smarterproctoring.com/v2/installs/{installSid}/provision \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '{
  "course": {
    "ids": {
      "sid": "<string>",
      "api": "<string>",
      "lms": "<string>",
      "external": "<string>"
    },
    "title": "<string>",
    "code": "<string>"
  },
  "user": {
    "ids": {
      "sid": "<string>",
      "api": "<string>",
      "lms": "<string>",
      "external": "<string>"
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "currencyCode": "<string>",
    "timeZone": "<string>"
  },
  "enrollment": {
    "role": "learner"
  },
  "exam": {
    "ids": {
      "sid": "<string>",
      "external": "<string>"
    },
    "title": "<string>",
    "description": "<string>",
    "type": "online",
    "practice": false,
    "limitedScope": false,
    "deliverySystem": "<string>",
    "configuration": {
      "ids": "<string>",
      "type": "primary",
      "url": "<string>",
      "access": {
        "open": "<string>",
        "close": "<string>"
      },
      "scheduling": {
        "open": "<string>",
        "close": "<string>"
      },
      "duration": 123,
      "password": "<string>",
      "attempts": 1,
      "notes": {
        "student": "<string>",
        "proctor": "<string>"
      },
      "proctorTypes": {},
      "permittedItems": {}
    }
  },
  "signon": {
    "integrationSid": "<string>"
  }
}'

{
  "course": {
    "sid": "<string>",
    "result": "Created"
  },
  "user": {
    "sid": "<string>",
    "result": "Created"
  },
  "enrollment": {
    "sid": "<string>",
    "result": "Created"
  },
  "exam": {
    "sid": "<string>",
    "result": "Created"
  },
  "configuration": {
    "sid": "<string>",
    "result": "Created"
  },
  "signon": {
    "redirect": "<string>",
    "token": "<string>"
  }
}

POST

installs

{installSid}

provision

Provisions multiple types of data in a single call.

curl --request POST \
  --url https://api.smarterproctoring.com/v2/installs/{installSid}/provision \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '{
  "course": {
    "ids": {
      "sid": "<string>",
      "api": "<string>",
      "lms": "<string>",
      "external": "<string>"
    },
    "title": "<string>",
    "code": "<string>"
  },
  "user": {
    "ids": {
      "sid": "<string>",
      "api": "<string>",
      "lms": "<string>",
      "external": "<string>"
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "currencyCode": "<string>",
    "timeZone": "<string>"
  },
  "enrollment": {
    "role": "learner"
  },
  "exam": {
    "ids": {
      "sid": "<string>",
      "external": "<string>"
    },
    "title": "<string>",
    "description": "<string>",
    "type": "online",
    "practice": false,
    "limitedScope": false,
    "deliverySystem": "<string>",
    "configuration": {
      "ids": "<string>",
      "type": "primary",
      "url": "<string>",
      "access": {
        "open": "<string>",
        "close": "<string>"
      },
      "scheduling": {
        "open": "<string>",
        "close": "<string>"
      },
      "duration": 123,
      "password": "<string>",
      "attempts": 1,
      "notes": {
        "student": "<string>",
        "proctor": "<string>"
      },
      "proctorTypes": {},
      "permittedItems": {}
    }
  },
  "signon": {
    "integrationSid": "<string>"
  }
}'

{
  "course": {
    "sid": "<string>",
    "result": "Created"
  },
  "user": {
    "sid": "<string>",
    "result": "Created"
  },
  "enrollment": {
    "sid": "<string>",
    "result": "Created"
  },
  "exam": {
    "sid": "<string>",
    "result": "Created"
  },
  "configuration": {
    "sid": "<string>",
    "result": "Created"
  },
  "signon": {
    "redirect": "<string>",
    "token": "<string>"
  }
}

Batch Provision Endpoint

The Batch Provision endpoint provides a powerful and efficient way to create multiple proctoring resources in a single API call. This streamlined approach allows Learning Management Systems (LMS) and assessment platforms to provision large volumes of data with SmarterProctoring while minimizing network overhead and simplifying integration workflows.

Overview

With the Batch Provision endpoint, you can simultaneously provision and manage:

Courses: Create course information including metadata, instructors, and configuration
Users: Provision students, instructors, and administrators with appropriate roles and permissions
Exams: Set up assessment details with specific proctoring requirements and settings

This endpoint is particularly valuable for initial system setup, semester transitions, or any scenario requiring bulk data synchronization between your platform and SmarterProctoring.

Implementation Guidance

When implementing the Batch Provision endpoint, consider structuring your requests to group related resources together and include all necessary reference identifiers to establish proper relationships between entities.

Response Features

In addition to confirmation of provisioned resources, the response includes:

SSO Links: Secure Single Sign-On (SSO) links for users that can be used to provide direct access to the SmarterProctoring platform without requiring additional authentication steps

Sample Request Payloads

Create Course and Exam

Create a course and exam if they do not already exist.

{
"course": {
    "ids": {
        "api": "sample"
    },
    "title": "Sample Course",
    "code": "sample"
},
"exam": {
    "ids": {
        "external": "exam-1"
    },
    "title": "Sample Exam",
    "description": "This is just a sample exam.",
    "type": "online",
    "practice": false,
    "limitedScope": false,
    "deliverySystem": "",
    "configuration": {
        "ids": {
            "api": "config-1"
        },
        "type": "primary",
        "url": "https://validurl.com",
        "access": {
            "open": "2025-02-16T17:00:00Z",
            "close": "2025-02-20T17:00:00Z"
        },
        "scheduling": {
            "open": "",
            "close": ""
        },
        "duration": 60,
        "password": "a8wlquoaois",
        "attempts": 1,
        "notes": {
            "student": "student notes",
            "proctor": "proctor notes"
        },
        "proctorTypes": {
            "TS6d6011935f4646848ea4f7a29b4f61a5": {
                "options": {
                    "recordScreen": {},
                    "recordWebcam": {},
                    "recordAudio": {},
                    "forceFullScreen": {},
                    "onlyOneScreen": {},
                    "disableNewTabs": {},
                    "closeOpenTabs": {},
                    "disablePrinting": {},
                    "disableClipboard": {},
                    "disableRightClick": {},
                    "verifyId": {},
                    "roomScan": {}
                }
            }
        },
        "permittedItems": {
            "bathroomBreak": {
                "notes": "Porta-potty is out back."
            },
            "calculator": {
                "notes": "TI-85"
            },
            "dictionary": {
                "notes": "Only Nish dictionaries"
            },
            "earplugs": {
                "notes": "Things will get loud!"
            },
            "formulaSheet": {
                "notes": ""
            },
            "notes": {
                "notes": "handwritten only, nothing in print"
            },
            "textbook": {
                "notes": "Just the book \"Cultural Toolbox\" by Anton Treuer"
            },
            "websites": {
                "notes": ""
            }
        }
    }
}

Enroll Student Only

Enroll a student into an existing course, and ensure a signon link is returned so the user can access the system.

{
    "course": {
        "ids": {
            "sid": "CU8b2d9c5ef3e8471ab6cf19509beac183"
        }
    },
    "user": {
        "ids": {
            "api": "john-doe-123"
        },
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@smarterservices.com",
        "currencyCode": "USD",
        "timeZone": "America/New_York"
    },
    "enrollment": {
        "role": "learner"
    },
    "signon": {
        "integrationSid": "IIf5a9128504e251fad9e4a38dc0813f74"
    }
}

Request Parameters

The Batch Provision endpoint accepts a JSON payload containing the following parameters:

Authorizations

token

string

header

required

Path Parameters

installSid

string

required

Install Sid

Body

application/json

course

object

required

Course data

Show child attributes

user

object

User data object that will create a new user or update an existing user. If a subsequent course object is provide, the user will also be enrolled into the course.

Show child attributes

enrollment

any

Enrollment object is optional but can only exist if user is provided.

exam

object

Exam schema ensuring required and optional fields meet validation criteria.

Show child attributes

signon

object

Optional signon object.. If provided, integrationSid must be present. This will return the signon information to redirect the user to.

Show child attributes

Response

200 - application/json

Successful provision operation

course

object

required

Show child attributes

user

object

required

Show child attributes

enrollment

object

required

Show child attributes

exam

object

required

Show child attributes

configuration

object

required

Show child attributes

signon

object

Show child attributes

Resource Identifiers

Getting Started

API Reference

Batch Provision

Batch Provision Endpoint

Overview

Implementation Guidance

Response Features

Sample Request Payloads

Request Parameters

Authorizations

Path Parameters

Body

Response

Getting Started

API Reference

​Batch Provision Endpoint

​Overview

​Implementation Guidance

​Response Features

​Sample Request Payloads

​Request Parameters

Authorizations

Path Parameters

Body

Response

Batch Provision Endpoint

Overview

Implementation Guidance

Response Features

Sample Request Payloads

Request Parameters