GET api/v1/eligibilities?data={data}&scheduleMethod={scheduleMethod}

Request Information

URI Parameters

Name	Type	Additional information
ProgramCode	string	None.
ConfirmationNumber	Collection of string	None.
ExamCode	string	None.
data	EligibilityDemographicsBindingModel	Required
scheduleMethod	ScheduleMethod	Default value is Internet

Body Parameters

None.

Response Information

Resource Description

Collection of EligibilityBindingModel

Name	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": "2024-11-21T04:12:28.8527569-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": "2024-11-21T04:12:28.8527569-05:00"
    }
  },
  {
    "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": "2024-11-21T04:12:28.8527569-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": "2024-11-21T04:12:28.8527569-05:00"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfEligibilityBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models">
  <EligibilityBindingModel>
    <ClientCode>sample string 5</ClientCode>
    <ConsecutiveDays>true</ConsecutiveDays>
    <Demographics xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Demographics>
    <Exam xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
      <d3p1:Href>sample string 2</d3p1:Href>
      <d3p1:Id>sample string 1</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
      <d3p1:Countries xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:Countries>
      <d3p1:EndDate>2024-11-21T04:12:28.8527569-05:00</d3p1:EndDate>
      <d3p1:RegionCodes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:RegionCodes>
      <d3p1:Sites xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:Sites>
      <d3p1:StartDate>2024-11-21T04:12:28.8527569-05:00</d3p1:StartDate>
    </Restrictions>
    <Sessions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
      <d3p1:SessionBindingModel>
        <d3p1:Duration>PT0.1234567S</d3p1:Duration>
        <d3p1:Form>sample string 2</d3p1:Form>
        <d3p1:Sequence>1</d3p1:Sequence>
      </d3p1:SessionBindingModel>
      <d3p1:SessionBindingModel>
        <d3p1:Duration>PT0.1234567S</d3p1:Duration>
        <d3p1:Form>sample string 2</d3p1:Form>
        <d3p1:Sequence>1</d3p1:Sequence>
      </d3p1:SessionBindingModel>
    </Sessions>
    <Status>sample string 6</Status>
    <TestingAccommodations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.TestingAccommodation">
      <d3p1:TestingAccommodationBindingModel>
        <d3p1:Attributes>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
        </d3p1:Attributes>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:TestingAccommodationBindingModel>
      <d3p1:TestingAccommodationBindingModel>
        <d3p1:Attributes>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
        </d3p1:Attributes>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:TestingAccommodationBindingModel>
    </TestingAccommodations>
  </EligibilityBindingModel>
  <EligibilityBindingModel>
    <ClientCode>sample string 5</ClientCode>
    <ConsecutiveDays>true</ConsecutiveDays>
    <Demographics xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Demographics>
    <Exam xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
      <d3p1:Href>sample string 2</d3p1:Href>
      <d3p1:Id>sample string 1</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
      <d3p1:Countries xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:Countries>
      <d3p1:EndDate>2024-11-21T04:12:28.8527569-05:00</d3p1:EndDate>
      <d3p1:RegionCodes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:RegionCodes>
      <d3p1:Sites xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
        <d4p1:ResourceReferenceOfstring>
          <d4p1:Href>sample string 2</d4p1:Href>
          <d4p1:Id>sample string 1</d4p1:Id>
        </d4p1:ResourceReferenceOfstring>
      </d3p1:Sites>
      <d3p1:StartDate>2024-11-21T04:12:28.8527569-05:00</d3p1:StartDate>
    </Restrictions>
    <Sessions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.Eligibility">
      <d3p1:SessionBindingModel>
        <d3p1:Duration>PT0.1234567S</d3p1:Duration>
        <d3p1:Form>sample string 2</d3p1:Form>
        <d3p1:Sequence>1</d3p1:Sequence>
      </d3p1:SessionBindingModel>
      <d3p1:SessionBindingModel>
        <d3p1:Duration>PT0.1234567S</d3p1:Duration>
        <d3p1:Form>sample string 2</d3p1:Form>
        <d3p1:Sequence>1</d3p1:Sequence>
      </d3p1:SessionBindingModel>
    </Sessions>
    <Status>sample string 6</Status>
    <TestingAccommodations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models.TestingAccommodation">
      <d3p1:TestingAccommodationBindingModel>
        <d3p1:Attributes>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
        </d3p1:Attributes>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:TestingAccommodationBindingModel>
      <d3p1:TestingAccommodationBindingModel>
        <d3p1:Attributes>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
          <d3p1:AttributeBindingModel>
            <d3p1:Name>sample string 1</d3p1:Name>
            <d3p1:Parameters>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
              <d3p1:ParameterBindingModel>
                <d3p1:Name>sample string 1</d3p1:Name>
                <d3p1:Value>sample string 2</d3p1:Value>
              </d3p1:ParameterBindingModel>
            </d3p1:Parameters>
          </d3p1:AttributeBindingModel>
        </d3p1:Attributes>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:TestingAccommodationBindingModel>
    </TestingAccommodations>
  </EligibilityBindingModel>
</ArrayOfEligibilityBindingModel>