POST api/{programid}/McoConfig/Configuration

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		integer	Required

Body Parameters

McoConfigurationParams

Name	Description	Type	Additional information
ConsumerNo		string	None.
DateOfService		date	None.

Request Formats

application/json, text/json

Sample:

{
  "ConsumerNo": "sample string 1",
  "DateOfService": "2024-11-16T09:34:06.314202+00:00"
}

application/xml, text/xml

Sample:

<McoConfigurationParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Mco">
  <ConsumerNo>sample string 1</ConsumerNo>
  <DateOfService>2024-11-16T09:34:06.314202+00:00</DateOfService>
</McoConfigurationParams>

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

Response Information

Resource Description

McoConfiguration

Name	Type	Additional information
ESignature	boolean	None.
ShowGeoLocation	boolean	None.
ManualEntryCapture	boolean	None.
ClockInLocationRequired	boolean	None.
LocationRequired	boolean	None.
AllowEditEntry	boolean	None.
MaxClockInMiles	decimal number	None.
ShowManualEntryReasons	boolean	None.
ManualEntryReasonsOptional	boolean	None.
MaxShiftDuration	integer	None.
EvvTimeEditToleranceMinutes	integer	None.
ShowAlternateLocation	boolean	None.
ShowServiceLocation	boolean	None.
ShowEvvWarningMsg	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ESignature": true,
  "ShowGeoLocation": true,
  "ManualEntryCapture": true,
  "ClockInLocationRequired": true,
  "LocationRequired": true,
  "AllowEditEntry": true,
  "MaxClockInMiles": 7.1,
  "ShowManualEntryReasons": true,
  "ManualEntryReasonsOptional": true,
  "MaxShiftDuration": 10,
  "EvvTimeEditToleranceMinutes": 11,
  "ShowAlternateLocation": true,
  "ShowServiceLocation": true,
  "ShowEvvWarningMsg": true
}

application/xml, text/xml

Sample:

<McoConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Mco">
  <AllowEditEntry>true</AllowEditEntry>
  <ClockInLocationRequired>true</ClockInLocationRequired>
  <ESignature>true</ESignature>
  <EvvTimeEditToleranceMinutes>11</EvvTimeEditToleranceMinutes>
  <LocationRequired>true</LocationRequired>
  <ManualEntryCapture>true</ManualEntryCapture>
  <ManualEntryReasonsOptional>true</ManualEntryReasonsOptional>
  <MaxClockInMiles>7.1</MaxClockInMiles>
  <MaxShiftDuration>10</MaxShiftDuration>
  <ShowAlternateLocation>true</ShowAlternateLocation>
  <ShowEvvWarningMsg>true</ShowEvvWarningMsg>
  <ShowGeoLocation>true</ShowGeoLocation>
  <ShowManualEntryReasons>true</ShowManualEntryReasons>
  <ShowServiceLocation>true</ShowServiceLocation>
</McoConfiguration>