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 AccreditationName | 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": "38bf6d8c-15e2-4ab1-85e4-b5aca5fafdad", "AccreditationTypeFk": "61a42264-d05c-4de3-a0b8-a4ae2f2cdf24", "AccreditationGroupFK": "074bda67-93cd-4826-95b7-e5bc6d0f0035", "ReplacementAccreditationFK": "6c76d498-c2e5-4c04-9f09-e7eca815c1e1", "CreatedBy": "f16492a3-f88b-4a01-a73c-ac483e14708b", "HomeGroup": "c6f84819-15dc-4adc-8853-4d881b7987ea", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "65811de0-8e51-4908-a133-992131163a3a", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "80c08a8f-bf5b-4810-bb67-21e92c706ed0", "Expires": "2024-09-19T14:49:52.3923685-04:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-09-19T14:49:52.3923685-04:00", "URL": "sample string 6", "Keywords": "sample string 7", "ExternalRef": "sample string 8", "Reference_ID": 1 }, { "AccreditationIDPK": "38bf6d8c-15e2-4ab1-85e4-b5aca5fafdad", "AccreditationTypeFk": "61a42264-d05c-4de3-a0b8-a4ae2f2cdf24", "AccreditationGroupFK": "074bda67-93cd-4826-95b7-e5bc6d0f0035", "ReplacementAccreditationFK": "6c76d498-c2e5-4c04-9f09-e7eca815c1e1", "CreatedBy": "f16492a3-f88b-4a01-a73c-ac483e14708b", "HomeGroup": "c6f84819-15dc-4adc-8853-4d881b7987ea", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "65811de0-8e51-4908-a133-992131163a3a", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "80c08a8f-bf5b-4810-bb67-21e92c706ed0", "Expires": "2024-09-19T14:49:52.3923685-04:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-09-19T14:49:52.3923685-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>074bda67-93cd-4826-95b7-e5bc6d0f0035</AccreditationGroupFK> <AccreditationIDPK>38bf6d8c-15e2-4ab1-85e4-b5aca5fafdad</AccreditationIDPK> <AccreditationTypeFk>61a42264-d05c-4de3-a0b8-a4ae2f2cdf24</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>80c08a8f-bf5b-4810-bb67-21e92c706ed0</CertificateImageFK> <Created>2024-09-19T14:49:52.3923685-04:00</Created> <CreatedBy>f16492a3-f88b-4a01-a73c-ac483e14708b</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-09-19T14:49:52.3923685-04:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>c6f84819-15dc-4adc-8853-4d881b7987ea</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>65811de0-8e51-4908-a133-992131163a3a</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>6c76d498-c2e5-4c04-9f09-e7eca815c1e1</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Accreditation> <AccreditationGroupFK>074bda67-93cd-4826-95b7-e5bc6d0f0035</AccreditationGroupFK> <AccreditationIDPK>38bf6d8c-15e2-4ab1-85e4-b5aca5fafdad</AccreditationIDPK> <AccreditationTypeFk>61a42264-d05c-4de3-a0b8-a4ae2f2cdf24</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>80c08a8f-bf5b-4810-bb67-21e92c706ed0</CertificateImageFK> <Created>2024-09-19T14:49:52.3923685-04:00</Created> <CreatedBy>f16492a3-f88b-4a01-a73c-ac483e14708b</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-09-19T14:49:52.3923685-04:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>c6f84819-15dc-4adc-8853-4d881b7987ea</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>65811de0-8e51-4908-a133-992131163a3a</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>6c76d498-c2e5-4c04-9f09-e7eca815c1e1</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> </ArrayOfAccreditation>