GET PlanCare2Api/Clients/{clientId}/CovVerifications

Get the COV verification by client ID

At least one of these modules is required: RelationManagement

Requires 'Read' permission for function ClientCovVerification {257DE205-6F91-4688-AB5F-4267E563CF55}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

internal client identifier

integer

Required

Body Parameters

None.

Response Information

Resource Description

The CovVerification for a client

Collection of CovVerification
NameDescriptionTypeAdditional information
UzoviNumber

Uzovi Number

string

None.

InsuranceNumber

Insurance number

string

None.

Insurer

Insurer

string

None.

InsuranceTypeId

Insurancetype id

integer

None.

InsuranceTypeDescription

InsuranceType as text

string

None.

PackageCode

Package code

string

None.

PackageName

Package name

string

None.

LabelCode

Label code

string

None.

LabelName

Label name

string

None.

StartDate

Start date

date

None.

EndDate

End date

date

None.

RunDate

Run date

date

None.

Manual

Manual

boolean

None.

ResultCodeCovId

COV Result code id

integer

None.

ResultCodeCovDescription

COV result code as text

string

None.

RelationById

Relation id of the person who performed the COV verification

integer

None.

RelationByDescription

The person who performed the COV verification as text

string

None.

SourceText

Source as text

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "UzoviNumber": "sample string 1",
    "InsuranceNumber": "sample string 2",
    "Insurer": "sample string 3",
    "InsuranceTypeId": 1,
    "InsuranceTypeDescription": "sample string 4",
    "PackageCode": "sample string 5",
    "PackageName": "sample string 6",
    "LabelCode": "sample string 7",
    "LabelName": "sample string 8",
    "StartDate": "2026-05-26T21:02:50.112311+02:00",
    "EndDate": "2026-05-26T21:02:50.112311+02:00",
    "RunDate": "2026-05-26T21:02:50.112311+02:00",
    "Manual": true,
    "ResultCodeCovId": 1,
    "ResultCodeCovDescription": "sample string 12",
    "RelationById": 1,
    "RelationByDescription": "sample string 13",
    "SourceText": "sample string 14"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCovVerification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <CovVerification>
    <EndDate>2026-05-26T21:02:50.112311+02:00</EndDate>
    <InsuranceNumber>sample string 2</InsuranceNumber>
    <InsuranceTypeDescription>sample string 4</InsuranceTypeDescription>
    <InsuranceTypeId>1</InsuranceTypeId>
    <Insurer>sample string 3</Insurer>
    <LabelCode>sample string 7</LabelCode>
    <LabelName>sample string 8</LabelName>
    <Manual>true</Manual>
    <PackageCode>sample string 5</PackageCode>
    <PackageName>sample string 6</PackageName>
    <RelationByDescription>sample string 13</RelationByDescription>
    <RelationById>1</RelationById>
    <ResultCodeCovDescription>sample string 12</ResultCodeCovDescription>
    <ResultCodeCovId>1</ResultCodeCovId>
    <RunDate>2026-05-26T21:02:50.112311+02:00</RunDate>
    <SourceText>sample string 14</SourceText>
    <StartDate>2026-05-26T21:02:50.112311+02:00</StartDate>
    <UzoviNumber>sample string 1</UzoviNumber>
  </CovVerification>
  <CovVerification>
    <EndDate>2026-05-26T21:02:50.112311+02:00</EndDate>
    <InsuranceNumber>sample string 2</InsuranceNumber>
    <InsuranceTypeDescription>sample string 4</InsuranceTypeDescription>
    <InsuranceTypeId>1</InsuranceTypeId>
    <Insurer>sample string 3</Insurer>
    <LabelCode>sample string 7</LabelCode>
    <LabelName>sample string 8</LabelName>
    <Manual>true</Manual>
    <PackageCode>sample string 5</PackageCode>
    <PackageName>sample string 6</PackageName>
    <RelationByDescription>sample string 13</RelationByDescription>
    <RelationById>1</RelationById>
    <ResultCodeCovDescription>sample string 12</ResultCodeCovDescription>
    <ResultCodeCovId>1</ResultCodeCovId>
    <RunDate>2026-05-26T21:02:50.112311+02:00</RunDate>
    <SourceText>sample string 14</SourceText>
    <StartDate>2026-05-26T21:02:50.112311+02:00</StartDate>
    <UzoviNumber>sample string 1</UzoviNumber>
  </CovVerification>
</ArrayOfCovVerification>