Breadcrumbs Surpass API v2 > API v2 Reference > Item Authoring > Item API

Item API

An item is a page that appears in a test. Items may be scored questions (for example, Multiple Choice items), non-scored surveys (for example, Likert items), or basic pages (for example, Introduction, Information, and Finish Pages).

This article explains what calls can be made to the Surpass API using the Item resource.

Import this API into your Postman Workspace

In This Article

Items

The Item API resource can be used to list, retrieve, create, update, and delete question and survey items. For information on basic pages, read BasicPage API.

To learn more about items, see the Item Authoring section of the Surpass documentation.

Listing items

get /api/v2/Item

Send a request to the endpoint to retrieve a list of items. Refer to the available parameters to influence the response. No request body is required.

Retrieving item information

get /api/v2/Item/{id}

Send a request to the endpoint to retrieve information for a specific item using its ID. No request body is required.

Creating an item

post /api/v2/Item

Send a request to the endpoint to create an item.

Updating an item

put /api/v2/Item/{id}

Send a request to the endpoint to update a specific item.

Deleting an item

delete /api/v2/Item/{id}

Send a request to the endpoint to delete a specific item. No request body is required.

IMPORTANT: Items at any workflow status can be deleted using this API. If the item is not already in the subject’s recycle bin, the first request moves the item into the subject’s recycle bin (the permanentlyDeleted property is false) and then the second request permanently deletes the item (permanentlyDeleted is true).

Assistive Media

Assistive media are small audio and video files that can be added to items so that candidates can hear content in a chosen language or watch a visual aid. Assistive media can be used to improve the accessibility of your items or create unique assessment materials (for example, language testing).

The Item API resource can be used to retrieve and update assistive media.

To learn more about assistive media, read Adding assistive media to an item and Using assistive media in the test driver.

Retrieving assistive media information

get /api/v2/Item/{id}/AssistiveMedia/{id}

Send a request to the endpoint to retrieve information for a specific piece of assistive media using its ID. Refer to the available parameters to influence the response. No request body is required.

Updating assistive media

put /api/v2/Item/{id}/AssistiveMedia/{id}

Send a request to the endpoint to update a specific item’s assistive media.

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.

Further reading

Read the following articles to learn more about similar APIs, how to get started with the Surpass API v2, and how to get the best out of this reference documentation:

NOTE: This form is to provide feedback to help improve the Surpass Help documentation only. If you need live support, contact support@surpass.com.