Unassign and Reassign ProntoForms Teamwork-enabled forms Using the REST API

Supported on the Enterprise tier only:

This topic describes the unassign and reassign REST API endpoints and how to use them. These endpoints are only available when using ProntoForms Teamwork.

Prerequisites

• You must have at least one form with ProntoForms Teamwork enabled.
• To use the unassign endpoint, an incomplete form must be assigned to a user.
• To use the reassign endpoint, an incomplete form must not be assigned to a user.
• Note the Data ID number of the form submission that you want to unassign or reassign. Go to How to find the Data ID for more information.
• To use the reassign endpoint, note either the User ID, Username, or User Alias of the user who you want to reassign the form to. Go to Locate a User ID or Username, or Setting up User Aliases for more information.

Base URL

https://api.prontoforms.com

Note:You must use HTTPS to access the API endpoints.

Endpoints to unassign

Request parameters

None

Request header

Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.

cURL examples

curl -v -k -u {username:password} -X POST https://api.prontoforms.com/api/1.1/data/{dataId}/unassign

where username is the API Key ID, password is the API Key Secret, and dataId is a unique identifier for the form submission.

Request body

None

Response codes

200—OK

Response example

{
    "dataId": "180000000",
    "referenceNumber": "20000000-187000000"
}

Error codes

Endpoints to reassign

Request parameters

None

Request header

Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.

cURL examples

curl -v -k -u username:password -X POST https://api.prontoforms.com/api/1.1/data/{dataId}/reassign

where username is the API Key ID, password is the API Key Secret, and dataID is a unique identifier for the form submission.

Request body

Include a User ID, Username, or User Alias of the user you want to reassign the form to as shown in the following examples.

JSON

User ID example:

{
  "userID": 111111111
}

Username example:

{
  "username": "jdoe@prontoforms.com"
}

User Alias example:

{
  "userAlias":{
	"system": "testsystem"
	"alias": "janedoe"
  }
}

Response codes

200—OK

Response example

{
    "dataId": "180000000",
    "referenceNumber": "20000000-187111111"
}

Error codes

How to find the Data ID

1. Go to

   Data & Analytics > Submissions (by Form) > FormName > Continue
   or
   Manage Forms > FormName > Go to submissions

   Result: The Web Portal displays the Form Submissions page for the selected form.

2. Select the Reference # of the form submission that you want to unassign or reassign.

   Result: The system displays details of the incomplete form submission. You can find the Data ID in the URL.