GET api/programs/details
Get details of all programs
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of ProgramDetailsName | Description | 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": "7b382acb-69b7-4d30-a100-38aa15de312b", "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": "25a004e7-efb9-41c7-9d5f-b91bec30029c", "LanguageLabel": "sample string 3" }, { "Name": "sample string 1", "Id": "25a004e7-efb9-41c7-9d5f-b91bec30029c", "LanguageLabel": "sample string 3" } ] }, { "ProgramId": "7b382acb-69b7-4d30-a100-38aa15de312b", "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": "25a004e7-efb9-41c7-9d5f-b91bec30029c", "LanguageLabel": "sample string 3" }, { "Name": "sample string 1", "Id": "25a004e7-efb9-41c7-9d5f-b91bec30029c", "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>25a004e7-efb9-41c7-9d5f-b91bec30029c</Id> <LanguageLabel>sample string 3</LanguageLabel> <Name>sample string 1</Name> </AvailableLanguage> <AvailableLanguage> <Id>25a004e7-efb9-41c7-9d5f-b91bec30029c</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>7b382acb-69b7-4d30-a100-38aa15de312b</ProgramId> <ProgramSuffix>sample string 5</ProgramSuffix> <ShortDescription>sample string 4</ShortDescription> <ShortName>sample string 3</ShortName> </ProgramDetails> <ProgramDetails> <AvailableLanguages> <AvailableLanguage> <Id>25a004e7-efb9-41c7-9d5f-b91bec30029c</Id> <LanguageLabel>sample string 3</LanguageLabel> <Name>sample string 1</Name> </AvailableLanguage> <AvailableLanguage> <Id>25a004e7-efb9-41c7-9d5f-b91bec30029c</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>7b382acb-69b7-4d30-a100-38aa15de312b</ProgramId> <ProgramSuffix>sample string 5</ProgramSuffix> <ShortDescription>sample string 4</ShortDescription> <ShortName>sample string 3</ShortName> </ProgramDetails> </ArrayOfProgramDetails>