POST api/{programid}/Timesheets/SearchTimeEntriesDashboard

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

TimeEntryDashboardSearchFiltersDTO

Name	Type	Additional information
BeginDate	string	None.
EndDate	string	None.
ProviderName	string	None.
ConsumerName	string	None.
LineStatuses	Collection of string	None.
LocationDiscrepancy	boolean	None.
CurrentClockIn	boolean	None.
SortCriteria	string	None.
RowsByPage	integer	None.
PageNum	integer	None.
CaseManagerNo	string	None.
CaseManagerAgencyNo	string	None.
ServiceFacilitatorNo	string	None.
ServiceFacilitatorAgencyNo	string	None.
UserRoleContext	Collection of RoleContext	None.

Request Formats

application/json, text/json

Sample:

{
  "BeginDate": "sample string 1",
  "EndDate": "sample string 2",
  "ProviderName": "sample string 3",
  "ConsumerName": "sample string 4",
  "LineStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "LocationDiscrepancy": true,
  "CurrentClockIn": true,
  "SortCriteria": "sample string 7",
  "RowsByPage": 8,
  "PageNum": 9,
  "CaseManagerNo": "sample string 10",
  "CaseManagerAgencyNo": "sample string 11",
  "ServiceFacilitatorNo": "sample string 12",
  "ServiceFacilitatorAgencyNo": "sample string 13",
  "UserRoleContext": [
    {
      "AssemblyName": "sample string 1",
      "Namespace": "sample string 2",
      "FieldName": "sample string 3",
      "ObjectName": "sample string 4",
      "MappingFieldNameOnContextViewInDB": "sample string 5",
      "FieldValue": "sample string 6"
    },
    {
      "AssemblyName": "sample string 1",
      "Namespace": "sample string 2",
      "FieldName": "sample string 3",
      "ObjectName": "sample string 4",
      "MappingFieldNameOnContextViewInDB": "sample string 5",
      "FieldValue": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<TimeEntryDashboardSearchFiltersDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <UserRoleContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.DataProviders.Common" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Common">
    <d2p1:RoleContext>
      <d2p1:AssemblyName>sample string 1</d2p1:AssemblyName>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldValue>sample string 6</d2p1:FieldValue>
      <d2p1:MappingFieldNameOnContextViewInDB>sample string 5</d2p1:MappingFieldNameOnContextViewInDB>
      <d2p1:Namespace>sample string 2</d2p1:Namespace>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
    </d2p1:RoleContext>
    <d2p1:RoleContext>
      <d2p1:AssemblyName>sample string 1</d2p1:AssemblyName>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldValue>sample string 6</d2p1:FieldValue>
      <d2p1:MappingFieldNameOnContextViewInDB>sample string 5</d2p1:MappingFieldNameOnContextViewInDB>
      <d2p1:Namespace>sample string 2</d2p1:Namespace>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
    </d2p1:RoleContext>
  </UserRoleContext>
  <BeginDate>sample string 1</BeginDate>
  <CaseManagerAgencyNo>sample string 11</CaseManagerAgencyNo>
  <CaseManagerNo>sample string 10</CaseManagerNo>
  <ConsumerName>sample string 4</ConsumerName>
  <CurrentClockIn>true</CurrentClockIn>
  <EndDate>sample string 2</EndDate>
  <LineStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LineStatuses>
  <LocationDiscrepancy>true</LocationDiscrepancy>
  <PageNum>9</PageNum>
  <ProviderName>sample string 3</ProviderName>
  <RowsByPage>8</RowsByPage>
  <ServiceFacilitatorAgencyNo>sample string 13</ServiceFacilitatorAgencyNo>
  <ServiceFacilitatorNo>sample string 12</ServiceFacilitatorNo>
  <SortCriteria>sample string 7</SortCriteria>
</TimeEntryDashboardSearchFiltersDTO>

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 'TimeEntryDashboardSearchFiltersDTO'.

Response Information

Resource Description

TimeEntryDashboardSearchResultDTO

Name	Type	Additional information
TimeEntryDashboardLines	Collection of TimeEntryDashboardLineDTO	None.
TotalTSLines	integer	None.
TotalCompliant	integer	None.
TotalManual	integer	None.
TotalLocationNotRecorded	integer	None.
TotalTimeInLocationNotRecorded	integer	None.
TotalClockInLocDisc	integer	None.
TotalClockOutLocDisc	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalTSLines": 1,
  "TotalCompliant": 2,
  "TotalManual": 3,
  "TotalLocationNotRecorded": 4,
  "TotalTimeInLocationNotRecorded": 5,
  "TotalClockInLocDisc": 6,
  "TotalClockOutLocDisc": 7,
  "TimeEntryDashboardLines": [
    {
      "TimesheetNo": "sample string 1",
      "TimesheetLineNo": "sample string 2",
      "ConsumerNo": "sample string 3",
      "ProviderNo": "sample string 4",
      "DateWorked": "sample string 5",
      "TimeIn": "sample string 6",
      "TimeOut": "sample string 7",
      "ProviderName": "sample string 8",
      "ConsumerName": "sample string 9",
      "ClockInDistance": "sample string 10",
      "ClockOutDistance": "sample string 11",
      "LocationRecorded": "sample string 12",
      "TimeInLocationRecorded": "sample string 13",
      "ManualEntry": "sample string 14",
      "LineStatus": "sample string 15",
      "Note": "sample string 16",
      "ServiceCode": "sample string 17",
      "ServiceCodeDescription": "sample string 18",
      "Activities": [
        "sample string 1",
        "sample string 2"
      ],
      "RowNumber": "sample string 19"
    },
    {
      "TimesheetNo": "sample string 1",
      "TimesheetLineNo": "sample string 2",
      "ConsumerNo": "sample string 3",
      "ProviderNo": "sample string 4",
      "DateWorked": "sample string 5",
      "TimeIn": "sample string 6",
      "TimeOut": "sample string 7",
      "ProviderName": "sample string 8",
      "ConsumerName": "sample string 9",
      "ClockInDistance": "sample string 10",
      "ClockOutDistance": "sample string 11",
      "LocationRecorded": "sample string 12",
      "TimeInLocationRecorded": "sample string 13",
      "ManualEntry": "sample string 14",
      "LineStatus": "sample string 15",
      "Note": "sample string 16",
      "ServiceCode": "sample string 17",
      "ServiceCodeDescription": "sample string 18",
      "Activities": [
        "sample string 1",
        "sample string 2"
      ],
      "RowNumber": "sample string 19"
    }
  ]
}

application/xml, text/xml

Sample:

<TimeEntryDashboardSearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <TimeEntryDashboardLines>
    <TimeEntryDashboardLineDTO>
      <Activities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Activities>
      <ClockInDistance>sample string 10</ClockInDistance>
      <ClockOutDistance>sample string 11</ClockOutDistance>
      <ConsumerName>sample string 9</ConsumerName>
      <ConsumerNo>sample string 3</ConsumerNo>
      <DateWorked>sample string 5</DateWorked>
      <LineStatus>sample string 15</LineStatus>
      <LocationRecorded>sample string 12</LocationRecorded>
      <ManualEntry>sample string 14</ManualEntry>
      <Note>sample string 16</Note>
      <ProviderName>sample string 8</ProviderName>
      <ProviderNo>sample string 4</ProviderNo>
      <RowNumber>sample string 19</RowNumber>
      <ServiceCode>sample string 17</ServiceCode>
      <ServiceCodeDescription>sample string 18</ServiceCodeDescription>
      <TimeIn>sample string 6</TimeIn>
      <TimeInLocationRecorded>sample string 13</TimeInLocationRecorded>
      <TimeOut>sample string 7</TimeOut>
      <TimesheetLineNo>sample string 2</TimesheetLineNo>
      <TimesheetNo>sample string 1</TimesheetNo>
    </TimeEntryDashboardLineDTO>
    <TimeEntryDashboardLineDTO>
      <Activities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Activities>
      <ClockInDistance>sample string 10</ClockInDistance>
      <ClockOutDistance>sample string 11</ClockOutDistance>
      <ConsumerName>sample string 9</ConsumerName>
      <ConsumerNo>sample string 3</ConsumerNo>
      <DateWorked>sample string 5</DateWorked>
      <LineStatus>sample string 15</LineStatus>
      <LocationRecorded>sample string 12</LocationRecorded>
      <ManualEntry>sample string 14</ManualEntry>
      <Note>sample string 16</Note>
      <ProviderName>sample string 8</ProviderName>
      <ProviderNo>sample string 4</ProviderNo>
      <RowNumber>sample string 19</RowNumber>
      <ServiceCode>sample string 17</ServiceCode>
      <ServiceCodeDescription>sample string 18</ServiceCodeDescription>
      <TimeIn>sample string 6</TimeIn>
      <TimeInLocationRecorded>sample string 13</TimeInLocationRecorded>
      <TimeOut>sample string 7</TimeOut>
      <TimesheetLineNo>sample string 2</TimesheetLineNo>
      <TimesheetNo>sample string 1</TimesheetNo>
    </TimeEntryDashboardLineDTO>
  </TimeEntryDashboardLines>
  <TotalClockInLocDisc>6</TotalClockInLocDisc>
  <TotalClockOutLocDisc>7</TotalClockOutLocDisc>
  <TotalCompliant>2</TotalCompliant>
  <TotalLocationNotRecorded>4</TotalLocationNotRecorded>
  <TotalManual>3</TotalManual>
  <TotalTSLines>1</TotalTSLines>
  <TotalTimeInLocationNotRecorded>5</TotalTimeInLocationNotRecorded>
</TimeEntryDashboardSearchResultDTO>