GET api/v1/candidates/template/eligibility?ClientCode={ClientCode}&ProgramCode={ProgramCode}&ExamCode={ExamCode}&Id={Id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientCode

string

None.

ProgramCode

string

None.

ExamCode

string

None.

Id

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfTemplateDemographicsBindingModel
NameDescriptionTypeAdditional information
Results

Collection of TemplateDemographicsBindingModel

None.

TotalResults

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "Results": [
    {
      "DemographicTemplateId": 1,
      "Ordinal": 2,
      "Id": 3,
      "DisplayName": "sample string 4",
      "ServiceName": "sample string 5",
      "DemographicFieldMap": "sample string 6",
      "Key": "sample string 7",
      "IsUpdatable": true,
      "IsDisplayed": true,
      "IsRequired": true,
      "Data": "sample string 11",
      "MinLength": "sample string 12",
      "MaxLength": "sample string 13",
      "Options": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "DemographicTemplateId": 1,
      "Ordinal": 2,
      "Id": 3,
      "DisplayName": "sample string 4",
      "ServiceName": "sample string 5",
      "DemographicFieldMap": "sample string 6",
      "Key": "sample string 7",
      "IsUpdatable": true,
      "IsDisplayed": true,
      "IsRequired": true,
      "Data": "sample string 11",
      "MinLength": "sample string 12",
      "MaxLength": "sample string 13",
      "Options": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseWrapperBindingModelOfArrayOfTemplateDemographicsBindingModelEN_PNkT3A xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
  <TotalResults>1</TotalResults>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models">
    <d2p1:TemplateDemographicsBindingModel>
      <d2p1:Data>sample string 11</d2p1:Data>
      <d2p1:DemographicFieldMap>sample string 6</d2p1:DemographicFieldMap>
      <d2p1:DemographicTemplateId>1</d2p1:DemographicTemplateId>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:IsDisplayed>true</d2p1:IsDisplayed>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:IsUpdatable>true</d2p1:IsUpdatable>
      <d2p1:Key>sample string 7</d2p1:Key>
      <d2p1:MaxLength>sample string 13</d2p1:MaxLength>
      <d2p1:MinLength>sample string 12</d2p1:MinLength>
      <d2p1:Options xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Options>
      <d2p1:Ordinal>2</d2p1:Ordinal>
      <d2p1:ServiceName>sample string 5</d2p1:ServiceName>
    </d2p1:TemplateDemographicsBindingModel>
    <d2p1:TemplateDemographicsBindingModel>
      <d2p1:Data>sample string 11</d2p1:Data>
      <d2p1:DemographicFieldMap>sample string 6</d2p1:DemographicFieldMap>
      <d2p1:DemographicTemplateId>1</d2p1:DemographicTemplateId>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:IsDisplayed>true</d2p1:IsDisplayed>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:IsUpdatable>true</d2p1:IsUpdatable>
      <d2p1:Key>sample string 7</d2p1:Key>
      <d2p1:MaxLength>sample string 13</d2p1:MaxLength>
      <d2p1:MinLength>sample string 12</d2p1:MinLength>
      <d2p1:Options xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Options>
      <d2p1:Ordinal>2</d2p1:Ordinal>
      <d2p1:ServiceName>sample string 5</d2p1:ServiceName>
    </d2p1:TemplateDemographicsBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfTemplateDemographicsBindingModelEN_PNkT3A>