Keys | Description | Optional? | Empty | Type | Server |
---|---|---|---|---|---|
schedulingType | The type of scheduling set by admin each activity. 'Regular' OR 'AnchorDate' | No | No | String | WCP |
scheduling | Will have the scheduling detail of activity | No | No | Object | WCP |
startTime | Represent the start time of activity. | No | Yes | String | WCP |
endTime | Represent the end time of activity. | No | Yes | String | WCP |
anchorDate | Will have the anchor date detail. This will be present in case 'schedulingType = AnchorDate' | Yes | No | Object | WCP |
sourceType | Child Node of 'anchorDate' Represents the anchor date source. 'EnrollmentDate' OR 'ActivityResponse' EnrollmentDate: Date of user enrollment. ActivityResponse: Response of date type question. | No | No | String | WCP |
sourceActivityId | Child Node of 'anchorDate' Value of activity ID. Will be empty if sourceType == EnrollmentDate | No | Yes | String | WCP |
sourceKey | Child Node of 'anchorDate' Value of question key. Will be empty if sourceType == EnrollmentDate | No | Yes | String | WCP |
start & end | Will have the elapsed days from anchor date (positive value) or days before anchor date (negative value) and time | Yes | No | Object | WCP |
anchorDays | Child Node of 'start' or 'end' elapsed days from anchor date, positive or negative | No | No | Integer | WCP |
time | Child Node of 'start' or 'end' time of the anchor date. | No | No | String | WCP |
anchorRuns | Will have the elapsed days from anchor date (positive value) or days before anchor date (negative value) and time This will be present for frequency == Manual Scheduled | Yes | No | Object | WCP |
startDays | Child Node of 'anchorRuns' elapsed days from start anchor date, positive or negative | No | No | Integer | WCP |
endDays | Child Node of 'anchorRuns' elapsed days from end anchor date, positive or negative | No | No | Integer | WCP |
propertyMetadata | The details of this object are used to get participant properties from response server to calculate start date, enddate and runs for the activity. This will be present in case 'schedulingType = AnchorDate' and ‘sourceType’=ParticipantProperty | Yes | No | Object | WCP |
addNewRuns | This is used to identify whether to add new runs or update the run if frequency = Manual Scheduled and 'schedulingType = AnchorDate' and ‘sourceType’=ParticipantProperty | Yes | No | String | WCP |
activityStartDate | Added this field to support participant property feature. This is used to save the start date of the activity. | Yes | No | String | Registration |
activityEndDate | Added this field to support participant property feature. This is used to save the end date of the activity. | Yes | No | String | Registration |
anchorDateVersion | Added this field to support participant property feature. This is used to save the anchor date version. | Yes | No | String | Registration |
lastModifiedDate | Added this field to support participant property feature. This is used to save the last modified date of the modified of activityStartDate/activityEndDate. | Yes | No | String | Registration |
anchorDatecreatedDate | Added this field to support participant property feature. This is used to save the anchor date created date. | Yes | No | String | Registration |
customScheduleRuns | Added this field to support participant property feature. This is used to save the runs for manual schedule frequency type activity. | Yes | No | Object | Registration |
allowDataSharing | This is used to share the user's input on sharing their data to third parties. | No | No | String | Registration |