EndpointsHrm Shift Assignments

Hrm Shift Assignments

Function-calling namespace: hrmShiftAssignments

  • Base URL: https://api.aivida.in
  • Engine endpoint: POST /api
  • Auth: private API; Stack access token is required.
  • Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
  • Allowed roles: platform_admin, hr.
  • Missing or invalid token returns 401; authenticated users without an allowed role return 403.

assign

Source: backend/endpoints/hrm-shift-assignments/assign

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
employeeIdsarray<string>Yes-
shiftTemplateIdstringYes-
effectiveFromstringYes-
effectiveTostringNonullable

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmShiftAssignments",
  "apiName": "assign",
  "data": {
    "organizationId": "org_123",
    "employeeIds": [
      "employee_123"
    ],
    "shiftTemplateId": "shifttemplate_123",
    "effectiveFrom": "value"
  }
}'

Example Response

{ "status": "ok", "data": {} }

list

Source: backend/endpoints/hrm-shift-assignments/list

Input Fields

FieldTypeRequiredConstraints
organizationIdstringNo-
employeeIdstringNo-
pageintegerNo-
pageSizeintegerNo-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmShiftAssignments",
  "apiName": "list",
  "data": {
    "organizationId": "org_123"
  }
}'

Response Data Format

FieldTypeRequiredConstraints
itemsarray<object>No-
totalintegerNo-
pageintegerNo-
pageSizeintegerNo-
totalPagesintegerNo-

Response Data Format Nested Structures

items[] item

FieldTypeRequiredConstraints
idstringNo-
organizationIdstringNo-
employeeIdstringNo-
employeeNamestringNo-
shiftTemplateIdstringNo-
shiftTemplateNamestringNo-
startTimestringNoformat: HH:mm
endTimestringNoformat: HH:mm
effectiveFromstringNo-
effectiveTostringNo-
isDeletedbooleanNo-
deletedAtintegerNounix-ms timestamp; nullable
createdAtintegerNounix-ms timestamp
updatedAtintegerNounix-ms timestamp

Response Data Format Example

{
  "items": [
    {
      "id": "id_123",
      "organizationId": "org_123",
      "employeeId": "employee_123",
      "employeeName": "value",
      "shiftTemplateId": "shifttemplate_123",
      "shiftTemplateName": "value",
      "startTime": "10:30",
      "endTime": "10:30",
      "effectiveFrom": "value",
      "effectiveTo": "value",
      "isDeleted": false,
      "deletedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example Response

{
  "status": "ok",
  "data": {
    "items": [
      {
        "id": "id_123",
        "organizationId": "org_123",
        "employeeId": "employee_123",
        "employeeName": "value",
        "shiftTemplateId": "shifttemplate_123",
        "shiftTemplateName": "value",
        "startTime": "10:30",
        "endTime": "10:30",
        "effectiveFrom": "value",
        "effectiveTo": "value",
        "isDeleted": false,
        "deletedAt": 1710201600000,
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

remove

Source: backend/endpoints/hrm-shift-assignments/remove

Input Fields

FieldTypeRequiredConstraints
idstringNo-
organizationIdstringNo-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmShiftAssignments",
  "apiName": "remove",
  "data": {
    "organizationId": "org_123",
    "id": "id_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

update

Source: backend/endpoints/hrm-shift-assignments/update

Input Fields

FieldTypeRequiredConstraints
idstringNo-
organizationIdstringNo-
employeeIdsarray<string>No-
shiftTemplateIdstringNonullable
effectiveFromstringNonullable
effectiveTostringNonullable

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmShiftAssignments",
  "apiName": "update",
  "data": {
    "organizationId": "org_123",
    "id": "id_123",
    "employeeIds": [
      "employee_123"
    ]
  }
}'

Example Response

{ "status": "ok", "data": {} }
Hrm PayrollHrm Shift Templates