POST api/{programid}/Consumer/EVVUtilization

Call to get a list of Consumer EVV Utilization Objects

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

The Program ID

string

Required

Body Parameters

The Consumer No

ConsumerEVVUtilizationFiltersDTO
NameDescriptionTypeAdditional information
ConsumerNo

string

None.

EmployeeNo

string

None.

RecordType

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ConsumerNo": "sample string 1",
  "EmployeeNo": "sample string 2",
  "RecordType": 3
}

application/xml, text/xml

Sample:
<ConsumerEVVUtilizationFiltersDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ConsumerNo>sample string 1</ConsumerNo>
  <EmployeeNo>sample string 2</EmployeeNo>
  <RecordType>3</RecordType>
</ConsumerEVVUtilizationFiltersDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ConsumerEVVUtilizationFiltersDTO'.

Response Information

Resource Description

A List of Consumer EVV Utilization Objects

Collection of ConsumerEVVUtilization
NameDescriptionTypeAdditional information
Id

integer

None.

ConsumerNo

string

None.

ConsumerName

string

None.

EmployeeNo

string

None.

EmployeeName

string

None.

EntryType

string

None.

EvvShiftTotal

integer

None.

NonEvvShiftTotal

integer

None.

ShiftTotal

integer

None.

UtilizationRate

decimal number

None.

Plan

string

None.

SubPlan

string

None.

CreatedBy

string

None.

CreatedDateTime

date

None.

ModifiedBy

string

None.

ModifiedDateTime

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "ConsumerNo": "sample string 2",
    "ConsumerName": "sample string 3",
    "EmployeeNo": "sample string 4",
    "EmployeeName": "sample string 5",
    "EntryType": "sample string 6",
    "EvvShiftTotal": 7,
    "NonEvvShiftTotal": 8,
    "ShiftTotal": 9,
    "UtilizationRate": 10.0,
    "Plan": "sample string 11",
    "SubPlan": "sample string 12",
    "CreatedBy": "sample string 13",
    "CreatedDateTime": "2024-11-16T09:45:17.393987+00:00",
    "ModifiedBy": "sample string 14",
    "ModifiedDateTime": "2024-11-16T09:45:17.393987+00:00"
  },
  {
    "Id": 1,
    "ConsumerNo": "sample string 2",
    "ConsumerName": "sample string 3",
    "EmployeeNo": "sample string 4",
    "EmployeeName": "sample string 5",
    "EntryType": "sample string 6",
    "EvvShiftTotal": 7,
    "NonEvvShiftTotal": 8,
    "ShiftTotal": 9,
    "UtilizationRate": 10.0,
    "Plan": "sample string 11",
    "SubPlan": "sample string 12",
    "CreatedBy": "sample string 13",
    "CreatedDateTime": "2024-11-16T09:45:17.393987+00:00",
    "ModifiedBy": "sample string 14",
    "ModifiedDateTime": "2024-11-16T09:45:17.393987+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfConsumerEVVUtilization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ConsumerEVVUtilization>
    <ConsumerName>sample string 3</ConsumerName>
    <ConsumerNo>sample string 2</ConsumerNo>
    <CreatedBy>sample string 13</CreatedBy>
    <CreatedDateTime>2024-11-16T09:45:17.393987+00:00</CreatedDateTime>
    <EmployeeName>sample string 5</EmployeeName>
    <EmployeeNo>sample string 4</EmployeeNo>
    <EntryType>sample string 6</EntryType>
    <EvvShiftTotal>7</EvvShiftTotal>
    <Id>1</Id>
    <ModifiedBy>sample string 14</ModifiedBy>
    <ModifiedDateTime>2024-11-16T09:45:17.393987+00:00</ModifiedDateTime>
    <NonEvvShiftTotal>8</NonEvvShiftTotal>
    <Plan>sample string 11</Plan>
    <ShiftTotal>9</ShiftTotal>
    <SubPlan>sample string 12</SubPlan>
    <UtilizationRate>10</UtilizationRate>
  </ConsumerEVVUtilization>
  <ConsumerEVVUtilization>
    <ConsumerName>sample string 3</ConsumerName>
    <ConsumerNo>sample string 2</ConsumerNo>
    <CreatedBy>sample string 13</CreatedBy>
    <CreatedDateTime>2024-11-16T09:45:17.393987+00:00</CreatedDateTime>
    <EmployeeName>sample string 5</EmployeeName>
    <EmployeeNo>sample string 4</EmployeeNo>
    <EntryType>sample string 6</EntryType>
    <EvvShiftTotal>7</EvvShiftTotal>
    <Id>1</Id>
    <ModifiedBy>sample string 14</ModifiedBy>
    <ModifiedDateTime>2024-11-16T09:45:17.393987+00:00</ModifiedDateTime>
    <NonEvvShiftTotal>8</NonEvvShiftTotal>
    <Plan>sample string 11</Plan>
    <ShiftTotal>9</ShiftTotal>
    <SubPlan>sample string 12</SubPlan>
    <UtilizationRate>10</UtilizationRate>
  </ConsumerEVVUtilization>
</ArrayOfConsumerEVVUtilization>