POST api/{programid}/Consumer/GetCoPayDetails

Retrieves CoPay payment details for a given CoPay record

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

GetConsumerCoPayDetailsDTO

Name	Type	Additional information
ParticipantID	string	None.
StartDate	date	None.
EndDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantID": "sample string 1",
  "StartDate": "2024-11-16T09:38:41.7631789+00:00",
  "EndDate": "2024-11-16T09:38:41.7631789+00:00"
}

application/xml, text/xml

Sample:

<GetConsumerCoPayDetailsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <EndDate>2024-11-16T09:38:41.7631789+00:00</EndDate>
  <ParticipantID>sample string 1</ParticipantID>
  <StartDate>2024-11-16T09:38:41.7631789+00:00</StartDate>
</GetConsumerCoPayDetailsDTO>

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

Response Information

Resource Description

Collection of ConsumerCoPayDetails

Name	Type	Additional information
ConsumerNo	string	None.
CheckDate	date	None.
PplId	string	None.
Name	string	None.
PaymentId	string	None.
Amount	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ConsumerNo": "sample string 1",
    "CheckDate": "2024-11-16T09:38:41.7631789+00:00",
    "PplId": "sample string 3",
    "Name": "sample string 4",
    "PaymentId": "sample string 5",
    "Amount": 6.0
  },
  {
    "ConsumerNo": "sample string 1",
    "CheckDate": "2024-11-16T09:38:41.7631789+00:00",
    "PplId": "sample string 3",
    "Name": "sample string 4",
    "PaymentId": "sample string 5",
    "Amount": 6.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfConsumerCoPayDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ConsumerCoPayDetails>
    <Amount>6</Amount>
    <CheckDate>2024-11-16T09:38:41.7631789+00:00</CheckDate>
    <ConsumerNo>sample string 1</ConsumerNo>
    <Name>sample string 4</Name>
    <PaymentId>sample string 5</PaymentId>
    <PplId>sample string 3</PplId>
  </ConsumerCoPayDetails>
  <ConsumerCoPayDetails>
    <Amount>6</Amount>
    <CheckDate>2024-11-16T09:38:41.7631789+00:00</CheckDate>
    <ConsumerNo>sample string 1</ConsumerNo>
    <Name>sample string 4</Name>
    <PaymentId>sample string 5</PaymentId>
    <PplId>sample string 3</PplId>
  </ConsumerCoPayDetails>
</ArrayOfConsumerCoPayDetails>