Public Access Links

Creating a Link

Changed on

To create a new Public Access Link to this Form, you must send at least a displayName for the resulting Actor. You may also provide once: true if you want to create a link that can only be filled by each respondent once. This setting is enforced by Enketo using local device tracking; the link is still distributable to multiple recipients, and the enforcement can be defeated by using multiple browsers or devices.

You may also optionally provide a properties object to set pre-registered Actor Property values on the Link at creation time.

post/v1/projects/{projectId}/forms/{xmlFormId}/public-links

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/public-links
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Request body */*

displayNamestring required

The name of the Link, for keeping track of. This name is displayed on the Central administration website but not to survey respondents.

onceboolean

If set to true, an Enketo single submission survey will be created instead of a standard one, limiting respondents to a single submission each.

propertiesobject

An optional object mapping pre-registered Actor Property names to string values.

Example request

{
  "displayName": "my public link",
  "once": false,
  "properties": {
    "region": "North"
  }
}

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

tokenstring

If present, this is the Token to include as the st query parameter for this Public Link. If not present, this Public Link has been revoked.

onceboolean

If set to true, an Enketo single submission survey will be created instead of a standard one, limiting respondents to a single submission each.

Changes