GET classroomAPI/Portal/getAccreditationsAvailable?AccreditationType={AccreditationType}&CompanyID={CompanyID}&enabled={enabled}

Request Information

URI Parameters

Name	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	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": "b2302276-2791-456f-8e78-cdb111976141",
    "AccreditationTypeFk": "8dd489ad-8e07-463e-81a7-e97884cc782a",
    "AccreditationGroupFK": "5f9482e4-9180-4777-93dc-a18a436187b3",
    "ReplacementAccreditationFK": "9b23be0e-fae5-4409-8c8f-6aa8bd2e4071",
    "CreatedBy": "8d91b2a6-01ca-4377-b68b-fd565db19eea",
    "HomeGroup": "db088ead-0178-4bec-bee1-e6bbf56258a0",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Category": 1,
    "IncentiveIconFK": "fda8d3a6-f270-4e41-8c6c-800369af771f",
    "IncentiveIcon": "sample string 3",
    "IncentiveText": "sample string 4",
    "NoOfCourses": 1,
    "CertificateImage": "sample string 5",
    "CertificateImageFK": "fdae5268-7046-41db-ad40-e8b470e80701",
    "Expires": "2024-06-27T18:22:19.7773138+00:00",
    "AwardHomePage": 1,
    "Enabled": true,
    "Created": "2024-06-27T18:22:19.7773138+00:00",
    "URL": "sample string 6",
    "Keywords": "sample string 7",
    "ExternalRef": "sample string 8",
    "Reference_ID": 1
  },
  {
    "AccreditationIDPK": "b2302276-2791-456f-8e78-cdb111976141",
    "AccreditationTypeFk": "8dd489ad-8e07-463e-81a7-e97884cc782a",
    "AccreditationGroupFK": "5f9482e4-9180-4777-93dc-a18a436187b3",
    "ReplacementAccreditationFK": "9b23be0e-fae5-4409-8c8f-6aa8bd2e4071",
    "CreatedBy": "8d91b2a6-01ca-4377-b68b-fd565db19eea",
    "HomeGroup": "db088ead-0178-4bec-bee1-e6bbf56258a0",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Category": 1,
    "IncentiveIconFK": "fda8d3a6-f270-4e41-8c6c-800369af771f",
    "IncentiveIcon": "sample string 3",
    "IncentiveText": "sample string 4",
    "NoOfCourses": 1,
    "CertificateImage": "sample string 5",
    "CertificateImageFK": "fdae5268-7046-41db-ad40-e8b470e80701",
    "Expires": "2024-06-27T18:22:19.7773138+00:00",
    "AwardHomePage": 1,
    "Enabled": true,
    "Created": "2024-06-27T18:22:19.7773138+00: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>5f9482e4-9180-4777-93dc-a18a436187b3</AccreditationGroupFK>
    <AccreditationIDPK>b2302276-2791-456f-8e78-cdb111976141</AccreditationIDPK>
    <AccreditationTypeFk>8dd489ad-8e07-463e-81a7-e97884cc782a</AccreditationTypeFk>
    <AwardHomePage>1</AwardHomePage>
    <Category>1</Category>
    <CertificateImage>sample string 5</CertificateImage>
    <CertificateImageFK>fdae5268-7046-41db-ad40-e8b470e80701</CertificateImageFK>
    <Created>2024-06-27T18:22:19.7773138+00:00</Created>
    <CreatedBy>8d91b2a6-01ca-4377-b68b-fd565db19eea</CreatedBy>
    <Description>sample string 2</Description>
    <Enabled>true</Enabled>
    <Expires>2024-06-27T18:22:19.7773138+00:00</Expires>
    <ExternalRef>sample string 8</ExternalRef>
    <HomeGroup>db088ead-0178-4bec-bee1-e6bbf56258a0</HomeGroup>
    <IncentiveIcon>sample string 3</IncentiveIcon>
    <IncentiveIconFK>fda8d3a6-f270-4e41-8c6c-800369af771f</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>9b23be0e-fae5-4409-8c8f-6aa8bd2e4071</ReplacementAccreditationFK>
    <URL>sample string 6</URL>
  </Accreditation>
  <Accreditation>
    <AccreditationGroupFK>5f9482e4-9180-4777-93dc-a18a436187b3</AccreditationGroupFK>
    <AccreditationIDPK>b2302276-2791-456f-8e78-cdb111976141</AccreditationIDPK>
    <AccreditationTypeFk>8dd489ad-8e07-463e-81a7-e97884cc782a</AccreditationTypeFk>
    <AwardHomePage>1</AwardHomePage>
    <Category>1</Category>
    <CertificateImage>sample string 5</CertificateImage>
    <CertificateImageFK>fdae5268-7046-41db-ad40-e8b470e80701</CertificateImageFK>
    <Created>2024-06-27T18:22:19.7773138+00:00</Created>
    <CreatedBy>8d91b2a6-01ca-4377-b68b-fd565db19eea</CreatedBy>
    <Description>sample string 2</Description>
    <Enabled>true</Enabled>
    <Expires>2024-06-27T18:22:19.7773138+00:00</Expires>
    <ExternalRef>sample string 8</ExternalRef>
    <HomeGroup>db088ead-0178-4bec-bee1-e6bbf56258a0</HomeGroup>
    <IncentiveIcon>sample string 3</IncentiveIcon>
    <IncentiveIconFK>fda8d3a6-f270-4e41-8c6c-800369af771f</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>9b23be0e-fae5-4409-8c8f-6aa8bd2e4071</ReplacementAccreditationFK>
    <URL>sample string 6</URL>
  </Accreditation>
</ArrayOfAccreditation>