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": "293e60af-9167-42d2-8551-bfebe7b7b782",
"AccreditationTypeFk": "39fb5eff-9200-4b78-8ed0-afb17108c72d",
"AccreditationGroupFK": "e0a5ac9f-7ba2-43e6-b284-afe004bc5be4",
"ReplacementAccreditationFK": "683264d0-4e65-439b-80b6-93a589b234bc",
"CreatedBy": "44e204f8-c44c-4a0c-98a4-c003be82025f",
"HomeGroup": "e4979223-9cab-4b7c-b5f3-1a4e15c5d0be",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "7ceb2f8f-cc88-450d-855e-73cef90a5d3f",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "742e9588-3310-4124-8ead-c38f8fff4df3",
"Expires": "2025-12-26T03:48:18.5877704-05:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2025-12-26T03:48:18.5877704-05:00",
"URL": "sample string 6",
"Keywords": "sample string 7",
"ExternalRef": "sample string 8",
"Reference_ID": 1
},
{
"AccreditationIDPK": "293e60af-9167-42d2-8551-bfebe7b7b782",
"AccreditationTypeFk": "39fb5eff-9200-4b78-8ed0-afb17108c72d",
"AccreditationGroupFK": "e0a5ac9f-7ba2-43e6-b284-afe004bc5be4",
"ReplacementAccreditationFK": "683264d0-4e65-439b-80b6-93a589b234bc",
"CreatedBy": "44e204f8-c44c-4a0c-98a4-c003be82025f",
"HomeGroup": "e4979223-9cab-4b7c-b5f3-1a4e15c5d0be",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "7ceb2f8f-cc88-450d-855e-73cef90a5d3f",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "742e9588-3310-4124-8ead-c38f8fff4df3",
"Expires": "2025-12-26T03:48:18.5877704-05:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2025-12-26T03:48:18.5877704-05: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>e0a5ac9f-7ba2-43e6-b284-afe004bc5be4</AccreditationGroupFK>
<AccreditationIDPK>293e60af-9167-42d2-8551-bfebe7b7b782</AccreditationIDPK>
<AccreditationTypeFk>39fb5eff-9200-4b78-8ed0-afb17108c72d</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>742e9588-3310-4124-8ead-c38f8fff4df3</CertificateImageFK>
<Created>2025-12-26T03:48:18.5877704-05:00</Created>
<CreatedBy>44e204f8-c44c-4a0c-98a4-c003be82025f</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2025-12-26T03:48:18.5877704-05:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>e4979223-9cab-4b7c-b5f3-1a4e15c5d0be</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>7ceb2f8f-cc88-450d-855e-73cef90a5d3f</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>683264d0-4e65-439b-80b6-93a589b234bc</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
<Accreditation>
<AccreditationGroupFK>e0a5ac9f-7ba2-43e6-b284-afe004bc5be4</AccreditationGroupFK>
<AccreditationIDPK>293e60af-9167-42d2-8551-bfebe7b7b782</AccreditationIDPK>
<AccreditationTypeFk>39fb5eff-9200-4b78-8ed0-afb17108c72d</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>742e9588-3310-4124-8ead-c38f8fff4df3</CertificateImageFK>
<Created>2025-12-26T03:48:18.5877704-05:00</Created>
<CreatedBy>44e204f8-c44c-4a0c-98a4-c003be82025f</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2025-12-26T03:48:18.5877704-05:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>e4979223-9cab-4b7c-b5f3-1a4e15c5d0be</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>7ceb2f8f-cc88-450d-855e-73cef90a5d3f</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>683264d0-4e65-439b-80b6-93a589b234bc</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
</ArrayOfAccreditation>