GET api/programs/details

Get details of all programs

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ProgramDetails

Name	Type	Additional information
ProgramId	globally unique identifier	None.
Name	string	None.
ShortName	string	None.
ShortDescription	string	None.
ProgramSuffix	string	None.
IsInternational	boolean	None.
IsOnline	boolean	None.
EligibilityRequirements	Collection of string	None.
AvailableLanguages	Collection of AvailableLanguage	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProgramId": "962fbc00-3726-4e2a-92c7-dad56603b9a9",
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "ShortDescription": "sample string 4",
    "ProgramSuffix": "sample string 5",
    "IsInternational": true,
    "IsOnline": true,
    "EligibilityRequirements": [
      "sample string 1",
      "sample string 2"
    ],
    "AvailableLanguages": [
      {
        "Name": "sample string 1",
        "Id": "ea4a2b87-1647-4937-b1e4-4021cb6f1904",
        "LanguageLabel": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "Id": "ea4a2b87-1647-4937-b1e4-4021cb6f1904",
        "LanguageLabel": "sample string 3"
      }
    ]
  },
  {
    "ProgramId": "962fbc00-3726-4e2a-92c7-dad56603b9a9",
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "ShortDescription": "sample string 4",
    "ProgramSuffix": "sample string 5",
    "IsInternational": true,
    "IsOnline": true,
    "EligibilityRequirements": [
      "sample string 1",
      "sample string 2"
    ],
    "AvailableLanguages": [
      {
        "Name": "sample string 1",
        "Id": "ea4a2b87-1647-4937-b1e4-4021cb6f1904",
        "LanguageLabel": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "Id": "ea4a2b87-1647-4937-b1e4-4021cb6f1904",
        "LanguageLabel": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProgramDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <ProgramDetails>
    <AvailableLanguages>
      <AvailableLanguage>
        <Id>ea4a2b87-1647-4937-b1e4-4021cb6f1904</Id>
        <LanguageLabel>sample string 3</LanguageLabel>
        <Name>sample string 1</Name>
      </AvailableLanguage>
      <AvailableLanguage>
        <Id>ea4a2b87-1647-4937-b1e4-4021cb6f1904</Id>
        <LanguageLabel>sample string 3</LanguageLabel>
        <Name>sample string 1</Name>
      </AvailableLanguage>
    </AvailableLanguages>
    <EligibilityRequirements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EligibilityRequirements>
    <IsInternational>true</IsInternational>
    <IsOnline>true</IsOnline>
    <Name>sample string 2</Name>
    <ProgramId>962fbc00-3726-4e2a-92c7-dad56603b9a9</ProgramId>
    <ProgramSuffix>sample string 5</ProgramSuffix>
    <ShortDescription>sample string 4</ShortDescription>
    <ShortName>sample string 3</ShortName>
  </ProgramDetails>
  <ProgramDetails>
    <AvailableLanguages>
      <AvailableLanguage>
        <Id>ea4a2b87-1647-4937-b1e4-4021cb6f1904</Id>
        <LanguageLabel>sample string 3</LanguageLabel>
        <Name>sample string 1</Name>
      </AvailableLanguage>
      <AvailableLanguage>
        <Id>ea4a2b87-1647-4937-b1e4-4021cb6f1904</Id>
        <LanguageLabel>sample string 3</LanguageLabel>
        <Name>sample string 1</Name>
      </AvailableLanguage>
    </AvailableLanguages>
    <EligibilityRequirements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EligibilityRequirements>
    <IsInternational>true</IsInternational>
    <IsOnline>true</IsOnline>
    <Name>sample string 2</Name>
    <ProgramId>962fbc00-3726-4e2a-92c7-dad56603b9a9</ProgramId>
    <ProgramSuffix>sample string 5</ProgramSuffix>
    <ShortDescription>sample string 4</ShortDescription>
    <ShortName>sample string 3</ShortName>
  </ProgramDetails>
</ArrayOfProgramDetails>