Setup

The Setup section of Surpass is where you can create and edit centres, subjects, users, and candidates. You can also view centre statistics, export subjects, and assign tags to candidates.

This page gives an overview of the Setup API v2 section of the Surpass Help Site.

Using the Setup APIs, you can create, read, update, and delete centres, subjects, users, candidates, and more in Surpass.

Read the following reference articles to learn more about the Setup APIs.

• Candidate API – The Candidate API resource is used to list, retrieve, create, and update candidates.
• Centre API – The Centre API resource is used to list, retrieve, create, and update centres.
• CentreSubjectAssociation API – The CentreSubjectAssociation API resource is used to list, retrieve, create, update, and delete centre and subject associations.
• Country API – The Country API resource is used to list and retrieve countries.
• County API – The County API resource is used to list and retrieve counties.
• Permission API – The Permission API resource is used to list permissions (roles).
• Subject API – The Subject API resource is used to list, retrieve, create, update, and delete subjects.
• TagCategory API – The TagCategory API resource is used to list, retrieve, create, update, and delete tag categories.
• TagCollectionGroup API – The TagCollectionGroup API resource is used to list, retrieve, create, and delete tag collection groups.
• TagGroup API – The TagGroup API resource is used to list, retrieve, create, and update tag groups.
• TagValue API – The TagValue API resource is used to list, retrieve, create, and update tag values.
• User API – The User API resource is used to list, retrieve, create, update, and delete users.
• UserPermission API – The UserPermission API resource is used to retrieve, assign, and delete user and permission (role) associations.
• WorkflowStatus API – The Workflow API resource is used to list workflow statuses.

For information about the Setup UI, read Setup.