Activities

Activity management operations

Get activities

get
/activity

Retrieve a list of activities with optional filtering and pagination

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
activityIdstring · uuidOptional
activityTitlestringOptional
activityTypestringOptional
memberIdstring · uuidOptional
activityStatusstringOptional
statusstringOptional
startDatestring · dateOptional
endDatestring · dateOptional
pageSizestringOptional
pageNumberstringOptional
sortBystringOptional
sortOrderstring · enumOptionalPossible values:
Responses
200

Successfully retrieved activities

application/json
get
/activity

Get unique activities

get
/activity/unique

Retrieve a list of unique activities without activity records

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
activityIdstring · uuidOptional
activityTitlestringOptional
activityTypestringOptional
statusstringOptional
pageSizestringOptional
pageNumberstringOptional
Responses
200

Successfully retrieved unique activities

application/json
get
/activity/unique

Get activity status count

get
/activity/status-count

Get count of activities by status

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startDatestring · dateOptional
endDatestring · dateOptional
Responses
200

Successfully retrieved status count

application/json
get
/activity/status-count

Get valid participants count

get
/activity/valid-participant/{activityId}

Get count of valid participants for an activity

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
activityIdstring · uuidRequired
Responses
200

Successfully retrieved participant count

application/json
get
/activity/valid-participant/{activityId}

Create activity

post
/activity/create

Create a new activity

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
activityTitlestring · max: 255Required
locationNamestring · max: 255Required
locationCoordinatestring · max: 255Required
otherLocationsobject[]OptionalDefault: []
unitstring · max: 255Required
eventLevelIdstring · uuid | nullableOptional
activityTypestring · max: 255Required
eventPointsstringOptional
durationsstringRequired
startDatetimestring · date-timeRequired
endDatetimestring · date-timeRequired
maxParticipantsnumberOptional
durationObjectionReasonbooleanOptional
Responses
200

Activity created successfully

application/json
post
/activity/create

Update activity

put
/activity/update/{activityId}

Update an existing activity

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
activityIdstring · uuidRequired
Body
activityTitlestringOptional
locationNamestringOptional
locationCoordinatestringOptional
startDatetimestring · date-timeOptional
endDatetimestring · date-timeOptional
durationsstringOptional
eventLevelIdstring · uuid | nullableOptional
maxParticipantsstringOptional
eventPointsstringOptional
eventHoursstringOptional
activityStatusstring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
unitstringOptional
otherLocationsobject[]Optional
updatedBystringOptional
Responses
200

Activity updated successfully

application/json
put
/activity/update/{activityId}

Cancel activity

put
/activity/cancel/{activityId}

Cancel an activity and reject all associated records

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
activityIdstring · uuidRequired
Body
cancelledReasonstring · max: 255Optional
Responses
200

Activity cancelled successfully

application/json
put
/activity/cancel/{activityId}

Complete activity

put
/activity/complete/{activityId}

Mark an activity as completed

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
activityIdstring · uuidRequired
Responses
200

Activity completed successfully

application/json
put
/activity/complete/{activityId}

Last updated