GET api/v1/departmentmatrix/bysummaryperiod/{departmentId}/{lookUpDateTime}/{deptPatientClassificationRangeId}

Get Staffing matrix. This is an asynchronous service. This is an asynchronous service.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
departmentId

The id of the department you want to lookup.

integer

Required

lookUpDateTime

This is a datetime parameter. The shift summary start time must be part of this value in order for the lookup to succeed.

date

Required

deptPatientClassificationRangeId

This is a deptPatientClassificationRangeId. (optional) The id of the PCS Level you want to lookup.

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

ApiResponseModelOfListOfStaffingGridSkillModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfListOfStaffingGridSkillModel

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PageSize": 1,
    "Page": 2,
    "TotalPages": 3,
    "TotalResults": 4,
    "Results": [
      {
        "DepartmentId": 1,
        "CensusLow": 2,
        "CensusPeak": 3,
        "Targets": [
          {
            "SkillLevelId": 1,
            "Skill": "sample string 2",
            "Target": 3.0,
            "SkillOrder": 4
          },
          {
            "SkillLevelId": 1,
            "Skill": "sample string 2",
            "Target": 3.0,
            "SkillOrder": 4
          }
        ],
        "Highlight": true,
        "PcsRangeName": "sample string 5"
      },
      {
        "DepartmentId": 1,
        "CensusLow": 2,
        "CensusPeak": 3,
        "Targets": [
          {
            "SkillLevelId": 1,
            "Skill": "sample string 2",
            "Target": 3.0,
            "SkillOrder": 4
          },
          {
            "SkillLevelId": 1,
            "Skill": "sample string 2",
            "Target": 3.0,
            "SkillOrder": 4
          }
        ],
        "Highlight": true,
        "PcsRangeName": "sample string 5"
      }
    ]
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}