Skip to main content

Division

idDivisionId (string)

The id of the division

Possible values: Value must match regular expression ^DV_[0-9a-zA-Z]{11,15}$

organizationIdDivisionString (string)

Possible values: <= 65536 characters

creationDatestring<date-time>nullable
creatorIdUserId (string)

Unique identifier for the user.

Possible values: Value must match regular expression ^((UR)|(URH))_[0-9a-zA-Z]{11,15}$

nameDivisionString (string)

Possible values: <= 65536 characters

permissions object

JSON object defining the division permissions.

property name*any

JSON object defining the division permissions.

responseCounts object

Learn More About Survey Response Counts

Review the Survey Response Counts document to learn more about the responseCounts object and its three properties: auditable, generated, and deleted.

auditableinteger<int32>nullablerequired

The cumulative count of all responses ever recorded and counted against the license, regardless of their current deletion status. This number:

  • Increases with each new response
  • Never decreases, even when responses are deleted
  • May include responses that are no longer accessible in the system
generatedinteger<int32>nullablerequired

The current count of active, non-auditable responses that are:

  • Accessible through the user interface
  • Not included in the auditable count
  • Subject to decrease if any of these responses are deleted
deletedinteger<int32>nullablerequired

A rolling count of responses removed from active use within the last 30 days. This number:

  • Increases when a response is deleted
  • Decreases 30 days after each deletion occurs
  • Does not include responses deleted more than 30 days ago, as these are permanently removed from the system and can no longer be recovered
statusDivisionAccountStatus (string)

New status of the division ("Active", "Disabled")

Possible values: [Active, Disabled]

Division
{
"id": "string",
"organizationId": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"creatorId": "string",
"name": "string",
"permissions": {},
"responseCounts": {
"auditable": 0,
"generated": 0,
"deleted": 0
},
"status": "Active"
}