Assignments

Single assignment details

get/api/v1/assignments/{id}

Request

  • Base URL: https://demo.mysurvey.solutions (the document declares no server; this is the origin it was published from)
  • URL: https://demo.mysurvey.solutions/api/v1/assignments/{id}
  • Auth: HTTP basic and HTTP bearer

Path parameters

idinteger required

Response

Assignment details

Idinteger
ResponsibleIdstring uuid
ResponsibleNamestring nullable

Name of the responsible person Can be used for ordering

QuestionnaireIdstring nullable

Questionnaire Id

InterviewsCountinteger

Quantity of submitted interviews for this assignment Can be used for ordering

Quantityinteger nullable

Maximum allowed quantity of interviews that can be created from this assignment Can be used for ordering

Archivedboolean

Archived status to filter by. True or False

CreatedAtUtcstring date-time

Date (UTC) when assignment were created Can be used for ordering

UpdatedAtUtcstring date-time

Last Update Date (UTC) of assignment Can be used for ordering

Emailstring nullable
Passwordstring nullable
TargetAreastring nullable
WebModeboolean nullable
ReceivedByTabletAtUtcstring date-time nullable

Represents date (UTC) when assignment was received by tablet

IsAudioRecordingEnabledboolean

Determines if interview from this assignment must record voice during interview (only on tablet)

AudioAuditScopestring[] nullable

List of section/group/roster variable names for which audio is recorded (selective Audio Audit). Empty when audio recording follows the WB.UI.Headquarters.API.PublicApi.Models.AssignmentViewItem.IsAudioRecordingEnabled flag.

Status'Open' | 'Completed' | 'Closed'

Changes

No recorded changes to this operation across all 1 revision of this API.