GET api/v1/Eligibilities/{id}?scheduleMethod={scheduleMethod}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| scheduleMethod | ScheduleMethod |
Default value is Internet |
Body Parameters
None.
Response Information
Resource Description
EligibilityBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| Href | string |
None. |
|
| Number | string |
None. |
|
| ProgramCode | string |
None. |
|
| ClientCode | string |
None. |
|
| Exam | ResourceReferenceOfString |
None. |
|
| Demographics | Dictionary of string [key] and string [value] |
None. |
|
| Status | string |
None. |
|
| TestingAccommodations | Collection of TestingAccommodationBindingModel |
None. |
|
| ConsecutiveDays | boolean |
None. |
|
| MaxDays | integer |
None. |
|
| Sessions | Collection of SessionBindingModel |
None. |
|
| Restrictions | RestrictionsBindingModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"Href": "sample string 2",
"Number": "sample string 3",
"ProgramCode": "sample string 4",
"ClientCode": "sample string 5",
"Exam": {
"Id": "sample string 1",
"Href": "sample string 2"
},
"Demographics": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"Status": "sample string 6",
"TestingAccommodations": [
{
"Name": "sample string 1",
"Attributes": [
{
"Name": "sample string 1",
"Parameters": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
{
"Name": "sample string 1",
"Attributes": [
{
"Name": "sample string 1",
"Parameters": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
]
}
],
"ConsecutiveDays": true,
"MaxDays": 8,
"Sessions": [
{
"Sequence": 1,
"Form": "sample string 2",
"Duration": "00:00:00.1234567"
},
{
"Sequence": 1,
"Form": "sample string 2",
"Duration": "00:00:00.1234567"
}
],
"Restrictions": {
"Countries": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"EndDate": "2025-11-04T18:33:23.9592521-05:00",
"RegionCodes": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"Sites": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"StartDate": "2025-11-04T18:33:23.9592521-05:00"
}
}
application/xml, text/xml
Sample:
<EligibilityBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models">
<ClientCode>sample string 5</ClientCode>
<ConsecutiveDays>true</ConsecutiveDays>
<Demographics xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Demographics>
<Exam xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</Exam>
<Href>sample string 2</Href>
<Id>sample string 1</Id>
<MaxDays>8</MaxDays>
<Number>sample string 3</Number>
<ProgramCode>sample string 4</ProgramCode>
<Restrictions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
<d2p1:Countries xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
</d2p1:Countries>
<d2p1:EndDate>2025-11-04T18:33:23.9592521-05:00</d2p1:EndDate>
<d2p1:RegionCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
</d2p1:RegionCodes>
<d2p1:Sites xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
<d3p1:ResourceReferenceOfstring>
<d3p1:Href>sample string 2</d3p1:Href>
<d3p1:Id>sample string 1</d3p1:Id>
</d3p1:ResourceReferenceOfstring>
</d2p1:Sites>
<d2p1:StartDate>2025-11-04T18:33:23.9592521-05:00</d2p1:StartDate>
</Restrictions>
<Sessions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
<d2p1:SessionBindingModel>
<d2p1:Duration>PT0.1234567S</d2p1:Duration>
<d2p1:Form>sample string 2</d2p1:Form>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:SessionBindingModel>
<d2p1:SessionBindingModel>
<d2p1:Duration>PT0.1234567S</d2p1:Duration>
<d2p1:Form>sample string 2</d2p1:Form>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:SessionBindingModel>
</Sessions>
<Status>sample string 6</Status>
<TestingAccommodations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.TestingAccommodation">
<d2p1:TestingAccommodationBindingModel>
<d2p1:Attributes>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
</d2p1:Attributes>
<d2p1:Name>sample string 1</d2p1:Name>
</d2p1:TestingAccommodationBindingModel>
<d2p1:TestingAccommodationBindingModel>
<d2p1:Attributes>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
</d2p1:Attributes>
<d2p1:Name>sample string 1</d2p1:Name>
</d2p1:TestingAccommodationBindingModel>
</TestingAccommodations>
</EligibilityBindingModel>