Activities

Activity management operations

Get activities

get

http://localhost:3000/api/v1https://api.example.com/v1

/activity

Retrieve a list of activities with optional filtering and pagination

Authorizations

BearerAuth

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

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/activity

HTTPcURLJavaScriptPython

GET /api/v1/activity HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "activityTitle": "text",
      "activityType": "text",
      "locationName": "text",
      "locationCoordinate": "text",
      "startDatetime": "2025-12-16T02:52:02.209Z",
      "endDatetime": "2025-12-16T02:52:02.209Z",
      "durations": "text",
      "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
      "maxParticipants": "text",
      "eventPoints": "text",
      "eventHours": "text",
      "createdBy": "text",
      "activityStatus": "scheduled",
      "approvalBy": "text",
      "approvalDate": "text",
      "cancelledBy": "text",
      "cancelledDate": "text",
      "cancelledReason": "text",
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z",
      "updatedBy": "text",
      "status": "active",
      "unit": "text",
      "otherLocations": [
        {}
      ]
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Get unique activities

get

http://localhost:3000/api/v1https://api.example.com/v1

/activity/unique

Retrieve a list of unique activities without activity records

Authorizations

BearerAuth

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

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/activity/unique

HTTPcURLJavaScriptPython

GET /api/v1/activity/unique HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "activityTitle": "text",
      "activityType": "text",
      "locationName": "text",
      "locationCoordinate": "text",
      "startDatetime": "2025-12-16T02:52:02.209Z",
      "endDatetime": "2025-12-16T02:52:02.209Z",
      "durations": "text",
      "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
      "maxParticipants": "text",
      "eventPoints": "text",
      "eventHours": "text",
      "createdBy": "text",
      "activityStatus": "scheduled",
      "approvalBy": "text",
      "approvalDate": "text",
      "cancelledBy": "text",
      "cancelledDate": "text",
      "cancelledReason": "text",
      "createdAt": "2025-12-16T02:52:02.209Z",
      "updatedAt": "2025-12-16T02:52:02.209Z",
      "updatedBy": "text",
      "status": "active",
      "unit": "text",
      "otherLocations": [
        {}
      ]
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Get activity status count

get

http://localhost:3000/api/v1https://api.example.com/v1

/activity/status-count

Get count of activities by status

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · dateOptional

endDatestring · dateOptional

Responses

200

Successfully retrieved status count

application/json

500

Internal server error

application/json

get

/activity/status-count

HTTPcURLJavaScriptPython

GET /api/v1/activity/status-count HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "count": {}
}

Get valid participants count

get

http://localhost:3000/api/v1https://api.example.com/v1

/activity/valid-participant/{activityId}

Get count of valid participants for an activity

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

activityIdstring · uuidRequired

Responses

200

Successfully retrieved participant count

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/activity/valid-participant/{activityId}

HTTPcURLJavaScriptPython

GET /api/v1/activity/valid-participant/{activityId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {}
}

Create activity

post

http://localhost:3000/api/v1https://api.example.com/v1

/activity/create

Create a new activity

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

400

Validation error

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

post

/activity/create

HTTPcURLJavaScriptPython

POST /api/v1/activity/create HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "activityTitle": "text",
  "locationName": "text",
  "locationCoordinate": "text",
  "otherLocations": [
    {}
  ],
  "unit": "text",
  "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
  "activityType": "text",
  "eventPoints": "text",
  "durations": "text",
  "startDatetime": "2025-12-16T02:52:02.209Z",
  "endDatetime": "2025-12-16T02:52:02.209Z",
  "maxParticipants": 1,
  "participants": [
    {
      "memberId": "123e4567-e89b-12d3-a456-426614174000",
      "participantRoleId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "durationObjectionReason": true
}

{
  "success": true,
  "message": "text",
  "data": {
    "activityId": "123e4567-e89b-12d3-a456-426614174000",
    "activityTitle": "text",
    "activityType": "text",
    "locationName": "text",
    "locationCoordinate": "text",
    "startDatetime": "2025-12-16T02:52:02.209Z",
    "endDatetime": "2025-12-16T02:52:02.209Z",
    "durations": "text",
    "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
    "maxParticipants": "text",
    "eventPoints": "text",
    "eventHours": "text",
    "createdBy": "text",
    "activityStatus": "scheduled",
    "approvalBy": "text",
    "approvalDate": "text",
    "cancelledBy": "text",
    "cancelledDate": "text",
    "cancelledReason": "text",
    "createdAt": "2025-12-16T02:52:02.209Z",
    "updatedAt": "2025-12-16T02:52:02.209Z",
    "updatedBy": "text",
    "status": "active",
    "unit": "text",
    "otherLocations": [
      {}
    ]
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Update activity

put

http://localhost:3000/api/v1https://api.example.com/v1

/activity/update/{activityId}

Update an existing activity

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

activityIdstring · uuidRequired

Body

application/json

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

400

Validation error

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

put

/activity/update/{activityId}

HTTPcURLJavaScriptPython

PUT /api/v1/activity/update/{activityId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "activityTitle": "text",
  "locationName": "text",
  "locationCoordinate": "text",
  "startDatetime": "2025-12-16T02:52:02.209Z",
  "endDatetime": "2025-12-16T02:52:02.209Z",
  "durations": "text",
  "eventLevelId": "123e4567-e89b-12d3-a456-426614174000",
  "maxParticipants": "text",
  "eventPoints": "text",
  "eventHours": "text",
  "activityStatus": "scheduled",
  "status": "active",
  "unit": "text",
  "otherLocations": [
    {}
  ],
  "updatedBy": "text"
}

{
  "success": true,
  "message": "text",
  "data": {},
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Cancel activity

put

http://localhost:3000/api/v1https://api.example.com/v1

/activity/cancel/{activityId}

Cancel an activity and reject all associated records

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

activityIdstring · uuidRequired

Body

application/json

cancelledReasonstring · max: 255Optional

Responses

200

Activity cancelled successfully

application/json

401

Unauthorized access

application/json

404

Activity not found

500

Internal server error

application/json

put

/activity/cancel/{activityId}

HTTPcURLJavaScriptPython

PUT /api/v1/activity/cancel/{activityId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "cancelledReason": "text"
}

{
  "success": true,
  "message": "text",
  "data": {}
}

Complete activity

put

http://localhost:3000/api/v1https://api.example.com/v1

/activity/complete/{activityId}

Mark an activity as completed

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

activityIdstring · uuidRequired

Responses

200

Activity completed successfully

application/json

401

Unauthorized access

application/json

403

Forbidden - cannot complete activity

404

Activity not found

500

Internal server error

application/json

put

/activity/complete/{activityId}

HTTPcURLJavaScriptPython

PUT /api/v1/activity/complete/{activityId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {}
}