GET classroomAPI/Portal/getAccreditationsAvailable?AccreditationType={AccreditationType}&CompanyID={CompanyID}&enabled={enabled}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AccreditationType | globally unique identifier |
Required |
|
| CompanyID | integer |
Required |
|
| enabled | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of Accreditation| Name | Description | Type | Additional information |
|---|---|---|---|
| AccreditationIDPK | globally unique identifier |
None. |
|
| AccreditationTypeFk | globally unique identifier |
None. |
|
| AccreditationGroupFK | globally unique identifier |
None. |
|
| ReplacementAccreditationFK | globally unique identifier |
None. |
|
| CreatedBy | globally unique identifier |
None. |
|
| HomeGroup | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| Category | integer |
None. |
|
| IncentiveIconFK | globally unique identifier |
None. |
|
| IncentiveIcon | string |
None. |
|
| IncentiveText | string |
None. |
|
| NoOfCourses | integer |
None. |
|
| CertificateImage | string |
None. |
|
| CertificateImageFK | globally unique identifier |
None. |
|
| Expires | date |
None. |
|
| AwardHomePage | integer |
None. |
|
| Enabled | boolean |
None. |
|
| Created | date |
None. |
|
| URL | string |
None. |
|
| Keywords | string |
None. |
|
| ExternalRef | string |
None. |
|
| Reference_ID | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AccreditationIDPK": "44ed0aa1-d367-4177-93ff-edef9e6ea2d7",
"AccreditationTypeFk": "89650f72-fec9-42f8-9e84-6badb493ef58",
"AccreditationGroupFK": "c0af14a6-19d7-417d-b6cf-f4ca5c3e579c",
"ReplacementAccreditationFK": "0f2b89bf-0646-4c0f-8a12-ca6d1ad00d1e",
"CreatedBy": "a3c62cb8-d16b-484d-a7df-0bb4c2679a31",
"HomeGroup": "41fd8d5b-7ea1-42a6-b611-40944cdd674d",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "0a695cd9-d4a2-4864-8706-83ac8da03990",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "c0a5a7fd-05b6-4deb-8e62-a24e2d92f13c",
"Expires": "2026-04-05T05:22:36.0956252-04:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2026-04-05T05:22:36.0956252-04:00",
"URL": "sample string 6",
"Keywords": "sample string 7",
"ExternalRef": "sample string 8",
"Reference_ID": 1
},
{
"AccreditationIDPK": "44ed0aa1-d367-4177-93ff-edef9e6ea2d7",
"AccreditationTypeFk": "89650f72-fec9-42f8-9e84-6badb493ef58",
"AccreditationGroupFK": "c0af14a6-19d7-417d-b6cf-f4ca5c3e579c",
"ReplacementAccreditationFK": "0f2b89bf-0646-4c0f-8a12-ca6d1ad00d1e",
"CreatedBy": "a3c62cb8-d16b-484d-a7df-0bb4c2679a31",
"HomeGroup": "41fd8d5b-7ea1-42a6-b611-40944cdd674d",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "0a695cd9-d4a2-4864-8706-83ac8da03990",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "c0a5a7fd-05b6-4deb-8e62-a24e2d92f13c",
"Expires": "2026-04-05T05:22:36.0956252-04:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2026-04-05T05:22:36.0956252-04:00",
"URL": "sample string 6",
"Keywords": "sample string 7",
"ExternalRef": "sample string 8",
"Reference_ID": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfAccreditation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL">
<Accreditation>
<AccreditationGroupFK>c0af14a6-19d7-417d-b6cf-f4ca5c3e579c</AccreditationGroupFK>
<AccreditationIDPK>44ed0aa1-d367-4177-93ff-edef9e6ea2d7</AccreditationIDPK>
<AccreditationTypeFk>89650f72-fec9-42f8-9e84-6badb493ef58</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>c0a5a7fd-05b6-4deb-8e62-a24e2d92f13c</CertificateImageFK>
<Created>2026-04-05T05:22:36.0956252-04:00</Created>
<CreatedBy>a3c62cb8-d16b-484d-a7df-0bb4c2679a31</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2026-04-05T05:22:36.0956252-04:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>41fd8d5b-7ea1-42a6-b611-40944cdd674d</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>0a695cd9-d4a2-4864-8706-83ac8da03990</IncentiveIconFK>
<IncentiveText>sample string 4</IncentiveText>
<Keywords>sample string 7</Keywords>
<Name>sample string 1</Name>
<NoOfCourses>1</NoOfCourses>
<Reference_ID>1</Reference_ID>
<ReplacementAccreditationFK>0f2b89bf-0646-4c0f-8a12-ca6d1ad00d1e</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
<Accreditation>
<AccreditationGroupFK>c0af14a6-19d7-417d-b6cf-f4ca5c3e579c</AccreditationGroupFK>
<AccreditationIDPK>44ed0aa1-d367-4177-93ff-edef9e6ea2d7</AccreditationIDPK>
<AccreditationTypeFk>89650f72-fec9-42f8-9e84-6badb493ef58</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>c0a5a7fd-05b6-4deb-8e62-a24e2d92f13c</CertificateImageFK>
<Created>2026-04-05T05:22:36.0956252-04:00</Created>
<CreatedBy>a3c62cb8-d16b-484d-a7df-0bb4c2679a31</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2026-04-05T05:22:36.0956252-04:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>41fd8d5b-7ea1-42a6-b611-40944cdd674d</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>0a695cd9-d4a2-4864-8706-83ac8da03990</IncentiveIconFK>
<IncentiveText>sample string 4</IncentiveText>
<Keywords>sample string 7</Keywords>
<Name>sample string 1</Name>
<NoOfCourses>1</NoOfCourses>
<Reference_ID>1</Reference_ID>
<ReplacementAccreditationFK>0f2b89bf-0646-4c0f-8a12-ca6d1ad00d1e</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
</ArrayOfAccreditation>