EndpointsHrm Shift Templates

Hrm Shift Templates

Function-calling namespace: hrmShiftTemplates

  • 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.

create

Source: backend/endpoints/hrm-shift-templates/create

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
shiftNamestringYes-
shiftCodestringYes-
startTimestringYesformat: HH:mm
endTimestringYesformat: HH:mm
weekoffDaystringYes-
statusstringYes-
descriptionstringNo-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmShiftTemplates",
  "apiName": "create",
  "data": {
    "organizationId": "org_123",
    "shiftName": "value",
    "shiftCode": "value",
    "startTime": "10:30",
    "endTime": "10:30",
    "weekoffDay": "value",
    "status": "scheduled"
  }
}'

Example Response

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

delete

Source: backend/endpoints/hrm-shift-templates/delete

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": "hrmShiftTemplates",
  "apiName": "delete",
  "data": {
    "organizationId": "org_123",
    "id": "id_123"
  }
}'

Example Response

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

getById

Source: backend/endpoints/hrm-shift-templates/get-by-id

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": "hrmShiftTemplates",
  "apiName": "getById",
  "data": {
    "organizationId": "org_123",
    "id": "id_123"
  }
}'

Example Response

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

list

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

Input Fields

FieldTypeRequiredConstraints
organizationIdstringNo-
statusstringNo-
searchstringNo-
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": "hrmShiftTemplates",
  "apiName": "list",
  "data": {
    "organizationId": "org_123",
    "status": "scheduled"
  }
}'

Response Data Format

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

Response Data Format Nested Structures

items[] item

FieldTypeRequiredConstraints
idstringNo-
organizationIdstringNo-
shiftNamestringNo-
shiftCodestringNo-
startTimestringNoformat: HH:mm
endTimestringNoformat: HH:mm
weekoffDaystringNo-
statusstringNo-
descriptionstringNo-
isDeletedbooleanNo-
deletedAtintegerNounix-ms timestamp; nullable
createdAtintegerNounix-ms timestamp
updatedAtintegerNounix-ms timestamp

Response Data Format Example

{
  "items": [
    {
      "id": "id_123",
      "organizationId": "org_123",
      "shiftName": "value",
      "shiftCode": "value",
      "startTime": "10:30",
      "endTime": "10:30",
      "weekoffDay": "value",
      "status": "scheduled",
      "description": "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",
        "shiftName": "value",
        "shiftCode": "value",
        "startTime": "10:30",
        "endTime": "10:30",
        "weekoffDay": "value",
        "status": "scheduled",
        "description": "value",
        "isDeleted": false,
        "deletedAt": 1710201600000,
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

update

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

Input Fields

FieldTypeRequiredConstraints
idstringNo-
organizationIdstringNo-
shiftNamestringNonullable
shiftCodestringNonullable
startTimestringNoformat: HH:mm; nullable
endTimestringNoformat: HH:mm; nullable
weekoffDaystringNonullable
statusstringNonullable
descriptionstringNonullable

Example Request

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

Example Response

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