POST api/{programid}/Consumer/GetCoPayForMyAccount

Retrieves CoPay records for a given consumer

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

GetConsumerCoPayDTO

Name	Description	Type	Additional information
ParticipantID		string	None.
Year		date	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantID": "sample string 1",
  "Year": "2024-11-16T04:42:20.9376905-05:00"
}

application/xml, text/xml

Sample:

<GetConsumerCoPayDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <ParticipantID>sample string 1</ParticipantID>
  <Year>2024-11-16T04:42:20.9376905-05:00</Year>
</GetConsumerCoPayDTO>

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

Response Information

Resource Description

GetConsumerCoPayResponse

Name	Description	Type	Additional information
CoPays		Collection of ConsumerCoPay	None.
CoPayYears		Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CoPays": [
    {
      "CoPayId": "sample string 1",
      "ConsumerNo": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "CoPayAmount": "sample string 5",
      "CoPayPaidAmt": "sample string 6",
      "CoPayBalance": "sample string 7",
      "TotalCoPayAmount": "sample string 8",
      "TTPCoPayAmount": "sample string 9",
      "TTPCoPayPaid": "sample string 10",
      "ConsumerCoPayParameters": "sample string 11",
      "Active": "sample string 12",
      "LastModifiedDateTime": "sample string 13",
      "ConsumerEmployee": [
        {
          "ConsumerEmployeeID": "sample string 1",
          "EmployeeNo": "sample string 2",
          "ConsumerNo": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "EmployeeName": "sample string 6",
          "EmployeeFirstName": "sample string 7",
          "EmployeeLastName": "sample string 8",
          "EmployeeExternalReferenceID": "sample string 9",
          "CoPaytoDeduct": "sample string 10",
          "CoPayPaid": "sample string 11"
        },
        {
          "ConsumerEmployeeID": "sample string 1",
          "EmployeeNo": "sample string 2",
          "ConsumerNo": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "EmployeeName": "sample string 6",
          "EmployeeFirstName": "sample string 7",
          "EmployeeLastName": "sample string 8",
          "EmployeeExternalReferenceID": "sample string 9",
          "CoPaytoDeduct": "sample string 10",
          "CoPayPaid": "sample string 11"
        }
      ]
    },
    {
      "CoPayId": "sample string 1",
      "ConsumerNo": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "CoPayAmount": "sample string 5",
      "CoPayPaidAmt": "sample string 6",
      "CoPayBalance": "sample string 7",
      "TotalCoPayAmount": "sample string 8",
      "TTPCoPayAmount": "sample string 9",
      "TTPCoPayPaid": "sample string 10",
      "ConsumerCoPayParameters": "sample string 11",
      "Active": "sample string 12",
      "LastModifiedDateTime": "sample string 13",
      "ConsumerEmployee": [
        {
          "ConsumerEmployeeID": "sample string 1",
          "EmployeeNo": "sample string 2",
          "ConsumerNo": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "EmployeeName": "sample string 6",
          "EmployeeFirstName": "sample string 7",
          "EmployeeLastName": "sample string 8",
          "EmployeeExternalReferenceID": "sample string 9",
          "CoPaytoDeduct": "sample string 10",
          "CoPayPaid": "sample string 11"
        },
        {
          "ConsumerEmployeeID": "sample string 1",
          "EmployeeNo": "sample string 2",
          "ConsumerNo": "sample string 3",
          "StartDate": "sample string 4",
          "EndDate": "sample string 5",
          "EmployeeName": "sample string 6",
          "EmployeeFirstName": "sample string 7",
          "EmployeeLastName": "sample string 8",
          "EmployeeExternalReferenceID": "sample string 9",
          "CoPaytoDeduct": "sample string 10",
          "CoPayPaid": "sample string 11"
        }
      ]
    }
  ],
  "CoPayYears": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<GetConsumerCoPayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Consumer">
  <CoPayYears xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CoPayYears>
  <CoPays xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses">
    <d2p1:ConsumerCoPay>
      <d2p1:Active>sample string 12</d2p1:Active>
      <d2p1:CoPayAmount>sample string 5</d2p1:CoPayAmount>
      <d2p1:CoPayBalance>sample string 7</d2p1:CoPayBalance>
      <d2p1:CoPayId>sample string 1</d2p1:CoPayId>
      <d2p1:CoPayPaidAmt>sample string 6</d2p1:CoPayPaidAmt>
      <d2p1:ConsumerCoPayParameters>sample string 11</d2p1:ConsumerCoPayParameters>
      <d2p1:ConsumerEmployee>
        <d2p1:ConsumerCoPayByEmployee>
          <d2p1:CoPayPaid>sample string 11</d2p1:CoPayPaid>
          <d2p1:CoPaytoDeduct>sample string 10</d2p1:CoPaytoDeduct>
          <d2p1:ConsumerEmployeeID>sample string 1</d2p1:ConsumerEmployeeID>
          <d2p1:ConsumerNo>sample string 3</d2p1:ConsumerNo>
          <d2p1:EmployeeExternalReferenceID>sample string 9</d2p1:EmployeeExternalReferenceID>
          <d2p1:EmployeeFirstName>sample string 7</d2p1:EmployeeFirstName>
          <d2p1:EmployeeLastName>sample string 8</d2p1:EmployeeLastName>
          <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
          <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
          <d2p1:EndDate>sample string 5</d2p1:EndDate>
          <d2p1:StartDate>sample string 4</d2p1:StartDate>
        </d2p1:ConsumerCoPayByEmployee>
        <d2p1:ConsumerCoPayByEmployee>
          <d2p1:CoPayPaid>sample string 11</d2p1:CoPayPaid>
          <d2p1:CoPaytoDeduct>sample string 10</d2p1:CoPaytoDeduct>
          <d2p1:ConsumerEmployeeID>sample string 1</d2p1:ConsumerEmployeeID>
          <d2p1:ConsumerNo>sample string 3</d2p1:ConsumerNo>
          <d2p1:EmployeeExternalReferenceID>sample string 9</d2p1:EmployeeExternalReferenceID>
          <d2p1:EmployeeFirstName>sample string 7</d2p1:EmployeeFirstName>
          <d2p1:EmployeeLastName>sample string 8</d2p1:EmployeeLastName>
          <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
          <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
          <d2p1:EndDate>sample string 5</d2p1:EndDate>
          <d2p1:StartDate>sample string 4</d2p1:StartDate>
        </d2p1:ConsumerCoPayByEmployee>
      </d2p1:ConsumerEmployee>
      <d2p1:ConsumerNo>sample string 2</d2p1:ConsumerNo>
      <d2p1:EndDate>sample string 4</d2p1:EndDate>
      <d2p1:LastModifiedDateTime>sample string 13</d2p1:LastModifiedDateTime>
      <d2p1:StartDate>sample string 3</d2p1:StartDate>
      <d2p1:TTPCoPayAmount>sample string 9</d2p1:TTPCoPayAmount>
      <d2p1:TTPCoPayPaid>sample string 10</d2p1:TTPCoPayPaid>
      <d2p1:TotalCoPayAmount>sample string 8</d2p1:TotalCoPayAmount>
    </d2p1:ConsumerCoPay>
    <d2p1:ConsumerCoPay>
      <d2p1:Active>sample string 12</d2p1:Active>
      <d2p1:CoPayAmount>sample string 5</d2p1:CoPayAmount>
      <d2p1:CoPayBalance>sample string 7</d2p1:CoPayBalance>
      <d2p1:CoPayId>sample string 1</d2p1:CoPayId>
      <d2p1:CoPayPaidAmt>sample string 6</d2p1:CoPayPaidAmt>
      <d2p1:ConsumerCoPayParameters>sample string 11</d2p1:ConsumerCoPayParameters>
      <d2p1:ConsumerEmployee>
        <d2p1:ConsumerCoPayByEmployee>
          <d2p1:CoPayPaid>sample string 11</d2p1:CoPayPaid>
          <d2p1:CoPaytoDeduct>sample string 10</d2p1:CoPaytoDeduct>
          <d2p1:ConsumerEmployeeID>sample string 1</d2p1:ConsumerEmployeeID>
          <d2p1:ConsumerNo>sample string 3</d2p1:ConsumerNo>
          <d2p1:EmployeeExternalReferenceID>sample string 9</d2p1:EmployeeExternalReferenceID>
          <d2p1:EmployeeFirstName>sample string 7</d2p1:EmployeeFirstName>
          <d2p1:EmployeeLastName>sample string 8</d2p1:EmployeeLastName>
          <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
          <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
          <d2p1:EndDate>sample string 5</d2p1:EndDate>
          <d2p1:StartDate>sample string 4</d2p1:StartDate>
        </d2p1:ConsumerCoPayByEmployee>
        <d2p1:ConsumerCoPayByEmployee>
          <d2p1:CoPayPaid>sample string 11</d2p1:CoPayPaid>
          <d2p1:CoPaytoDeduct>sample string 10</d2p1:CoPaytoDeduct>
          <d2p1:ConsumerEmployeeID>sample string 1</d2p1:ConsumerEmployeeID>
          <d2p1:ConsumerNo>sample string 3</d2p1:ConsumerNo>
          <d2p1:EmployeeExternalReferenceID>sample string 9</d2p1:EmployeeExternalReferenceID>
          <d2p1:EmployeeFirstName>sample string 7</d2p1:EmployeeFirstName>
          <d2p1:EmployeeLastName>sample string 8</d2p1:EmployeeLastName>
          <d2p1:EmployeeName>sample string 6</d2p1:EmployeeName>
          <d2p1:EmployeeNo>sample string 2</d2p1:EmployeeNo>
          <d2p1:EndDate>sample string 5</d2p1:EndDate>
          <d2p1:StartDate>sample string 4</d2p1:StartDate>
        </d2p1:ConsumerCoPayByEmployee>
      </d2p1:ConsumerEmployee>
      <d2p1:ConsumerNo>sample string 2</d2p1:ConsumerNo>
      <d2p1:EndDate>sample string 4</d2p1:EndDate>
      <d2p1:LastModifiedDateTime>sample string 13</d2p1:LastModifiedDateTime>
      <d2p1:StartDate>sample string 3</d2p1:StartDate>
      <d2p1:TTPCoPayAmount>sample string 9</d2p1:TTPCoPayAmount>
      <d2p1:TTPCoPayPaid>sample string 10</d2p1:TTPCoPayPaid>
      <d2p1:TotalCoPayAmount>sample string 8</d2p1:TotalCoPayAmount>
    </d2p1:ConsumerCoPay>
  </CoPays>
</GetConsumerCoPayResponse>