POST classroomAPI/Portal/setAward?UserID={UserID}&AwarderID={AwarderID}&AccreditationID={AccreditationID}&Reason={Reason}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserID | globally unique identifier |
Required |
|
AwarderID | globally unique identifier |
Required |
|
AccreditationID | globally unique identifier |
Required |
|
Reason | string |
Required |
Body Parameters
None.
Response Information
Resource Description
AccreditationsAwardedName | Description | Type | Additional information |
---|---|---|---|
AAIdPK | globally unique identifier |
None. |
|
AIDFK | globally unique identifier |
None. |
|
UserIdFK | globally unique identifier |
None. |
|
AwardedByFK | globally unique identifier |
None. |
|
VerifiedByFk | globally unique identifier |
None. |
|
Achieved | date |
None. |
|
LastAchieved | date |
None. |
|
ConfirmedOn | date |
None. |
|
Reference | string |
None. |
|
Reason | string |
None. |
|
Accreditation | Accreditation |
None. |
|
Awarder | UserSummary |
None. |
|
Awardee | UserSummary |
None. |
Response Formats
application/json, text/json
Sample:
{ "AAIdPK": "f5e9d4c5-40ed-4170-9f9b-83185f3092ec", "AIDFK": "12731a89-711e-4893-ac9f-fdd931ab0ce6", "UserIdFK": "ac77a849-3f4d-47b2-a2fb-59b6a782dcfa", "AwardedByFK": "5ded142c-b031-4ebe-a6ea-aae29b8fe570", "VerifiedByFk": "50d7dd1b-e63f-4456-a01f-29dcfb213b04", "Achieved": "2025-04-03T18:29:14.5100084-04:00", "LastAchieved": "2025-04-03T18:29:14.5100084-04:00", "ConfirmedOn": "2025-04-03T18:29:14.5100084-04:00", "Reference": "sample string 3", "Reason": "sample string 4", "Accreditation": { "AccreditationIDPK": "63f84c3f-4bc1-4541-acee-ccd4cade8884", "AccreditationTypeFk": "c7b45b81-7bd9-4f7f-83a5-c0e86f394ce0", "AccreditationGroupFK": "77085d38-7036-4fc5-82cd-d0b16b6e628c", "ReplacementAccreditationFK": "70c1a209-aabd-4058-b3c6-691050989306", "CreatedBy": "06e58f81-fa75-4af9-8675-f9fc4d650fc8", "HomeGroup": "a6ce229a-cdfb-4a04-a16d-1aa9aa5ef9ca", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "c7f27bdf-0a19-449d-8fbb-950f760c45b3", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "d3bb3f79-e95e-4e1c-af1d-e876f768093d", "Expires": "2025-04-03T18:29:14.5100084-04:00", "AwardHomePage": 1, "Enabled": true, "Created": "2025-04-03T18:29:14.5100084-04:00", "URL": "sample string 6", "Keywords": "sample string 7", "ExternalRef": "sample string 8", "Reference_ID": 1 }, "Awarder": { "JobTitle": "sample string 1", "Email": "sample string 2", "Telephone": "sample string 3", "USR_PROFILE": "sample string 4", "AvatarImage": "sample string 5", "FirstName": "sample string 6", "LastName": "sample string 7", "UserID": 8, "UserGUID": "34a273f5-d030-4c62-8053-a26167d882c9", "UserName": "sample string 10" }, "Awardee": { "JobTitle": "sample string 1", "Email": "sample string 2", "Telephone": "sample string 3", "USR_PROFILE": "sample string 4", "AvatarImage": "sample string 5", "FirstName": "sample string 6", "LastName": "sample string 7", "UserID": 8, "UserGUID": "34a273f5-d030-4c62-8053-a26167d882c9", "UserName": "sample string 10" } }
application/xml, text/xml
Sample:
<AccreditationsAwarded xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL"> <AAIdPK>f5e9d4c5-40ed-4170-9f9b-83185f3092ec</AAIdPK> <AIDFK>12731a89-711e-4893-ac9f-fdd931ab0ce6</AIDFK> <Accreditation> <AccreditationGroupFK>77085d38-7036-4fc5-82cd-d0b16b6e628c</AccreditationGroupFK> <AccreditationIDPK>63f84c3f-4bc1-4541-acee-ccd4cade8884</AccreditationIDPK> <AccreditationTypeFk>c7b45b81-7bd9-4f7f-83a5-c0e86f394ce0</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>d3bb3f79-e95e-4e1c-af1d-e876f768093d</CertificateImageFK> <Created>2025-04-03T18:29:14.5100084-04:00</Created> <CreatedBy>06e58f81-fa75-4af9-8675-f9fc4d650fc8</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2025-04-03T18:29:14.5100084-04:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>a6ce229a-cdfb-4a04-a16d-1aa9aa5ef9ca</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>c7f27bdf-0a19-449d-8fbb-950f760c45b3</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>70c1a209-aabd-4058-b3c6-691050989306</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Achieved>2025-04-03T18:29:14.5100084-04:00</Achieved> <AwardedByFK>5ded142c-b031-4ebe-a6ea-aae29b8fe570</AwardedByFK> <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>34a273f5-d030-4c62-8053-a26167d882c9</d2p1:UserGUID> <d2p1:UserID>8</d2p1:UserID> <d2p1:UserName>sample string 10</d2p1:UserName> <d2p1:FirstName>sample string 6</d2p1:FirstName> <d2p1:LastName>sample string 7</d2p1:LastName> <d2p1:AvatarImage>sample string 5</d2p1:AvatarImage> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:JobTitle>sample string 1</d2p1:JobTitle> <d2p1:Telephone>sample string 3</d2p1:Telephone> <d2p1:USR_PROFILE>sample string 4</d2p1:USR_PROFILE> </Awardee> <Awarder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>34a273f5-d030-4c62-8053-a26167d882c9</d2p1:UserGUID> <d2p1:UserID>8</d2p1:UserID> <d2p1:UserName>sample string 10</d2p1:UserName> <d2p1:FirstName>sample string 6</d2p1:FirstName> <d2p1:LastName>sample string 7</d2p1:LastName> <d2p1:AvatarImage>sample string 5</d2p1:AvatarImage> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:JobTitle>sample string 1</d2p1:JobTitle> <d2p1:Telephone>sample string 3</d2p1:Telephone> <d2p1:USR_PROFILE>sample string 4</d2p1:USR_PROFILE> </Awarder> <ConfirmedOn>2025-04-03T18:29:14.5100084-04:00</ConfirmedOn> <LastAchieved>2025-04-03T18:29:14.5100084-04:00</LastAchieved> <Reason>sample string 4</Reason> <Reference>sample string 3</Reference> <UserIdFK>ac77a849-3f4d-47b2-a2fb-59b6a782dcfa</UserIdFK> <VerifiedByFk>50d7dd1b-e63f-4456-a01f-29dcfb213b04</VerifiedByFk> </AccreditationsAwarded>