POST api/{programid}/Consumer/SetGPSConsentStatus

Sets the GPS Consent status for a consumer/employee pair.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

SetConsumerGPSConsentStatusRequest

Name	Type	Additional information
ConsumerNo	string	None.
EmployeeNo	string	None.
ConsumerConsentProvided	byte	None.
ConsumerConsentDate	date	None.
ConsumerSignature	string	None.
EmployeeConsentProvided	byte	None.
EmployeeConsentDate	date	None.
EmployeeSignature	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ConsumerNo": "sample string 1",
  "EmployeeNo": "sample string 2",
  "ConsumerConsentProvided": 64,
  "ConsumerConsentDate": "2025-08-15T22:58:03.7632595-04:00",
  "ConsumerSignature": "sample string 3",
  "EmployeeConsentProvided": 64,
  "EmployeeConsentDate": "2025-08-15T22:58:03.7632595-04:00",
  "EmployeeSignature": "sample string 4"
}

application/xml, text/xml

Sample:

<SetConsumerGPSConsentStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ConsumerConsentDate>2025-08-15T22:58:03.7632595-04:00</ConsumerConsentDate>
  <ConsumerConsentProvided>64</ConsumerConsentProvided>
  <ConsumerNo>sample string 1</ConsumerNo>
  <ConsumerSignature>sample string 3</ConsumerSignature>
  <EmployeeConsentDate>2025-08-15T22:58:03.7632595-04:00</EmployeeConsentDate>
  <EmployeeConsentProvided>64</EmployeeConsentProvided>
  <EmployeeNo>sample string 2</EmployeeNo>
  <EmployeeSignature>sample string 4</EmployeeSignature>
</SetConsumerGPSConsentStatusRequest>

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

Response Information

Resource Description

ConsumerGPSConsentStatus

Name	Type	Additional information
ConsumerNo	string	None.
EmployeeNo	string	None.
ConsumerConsentProvided	byte	None.
ConsumerConsentDate	date	None.
ConsumerSignature	string	None.
EmployeeConsentProvided	byte	None.
EmployeeConsentDate	date	None.
EmployeeSignature	string	None.
EffectiveDate	date	None.
EndDate	date	None.
PriorExpirationDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "ConsumerNo": "sample string 1",
  "EmployeeNo": "sample string 2",
  "ConsumerConsentProvided": 64,
  "ConsumerConsentDate": "2025-08-15T22:58:03.7789101-04:00",
  "ConsumerSignature": "sample string 3",
  "EmployeeConsentProvided": 64,
  "EmployeeConsentDate": "2025-08-15T22:58:03.7789101-04:00",
  "EmployeeSignature": "sample string 4",
  "EffectiveDate": "2025-08-15T22:58:03.7789101-04:00",
  "EndDate": "2025-08-15T22:58:03.7789101-04:00",
  "PriorExpirationDate": "2025-08-15T22:58:03.7789101-04:00"
}

application/xml, text/xml

Sample:

<ConsumerGPSConsentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ConsumerConsentDate>2025-08-15T22:58:03.7789101-04:00</ConsumerConsentDate>
  <ConsumerConsentProvided>64</ConsumerConsentProvided>
  <ConsumerNo>sample string 1</ConsumerNo>
  <ConsumerSignature>sample string 3</ConsumerSignature>
  <EffectiveDate>2025-08-15T22:58:03.7789101-04:00</EffectiveDate>
  <EmployeeConsentDate>2025-08-15T22:58:03.7789101-04:00</EmployeeConsentDate>
  <EmployeeConsentProvided>64</EmployeeConsentProvided>
  <EmployeeNo>sample string 2</EmployeeNo>
  <EmployeeSignature>sample string 4</EmployeeSignature>
  <EndDate>2025-08-15T22:58:03.7789101-04:00</EndDate>
  <PriorExpirationDate>2025-08-15T22:58:03.7789101-04:00</PriorExpirationDate>
</ConsumerGPSConsentStatus>