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
AccreditationsAwarded| Name | 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": "4241e64e-dd95-455a-97d6-f50fede592b8",
"AIDFK": "43e704c9-4f50-4e92-bc0d-c929b35c8aef",
"UserIdFK": "dedc5779-23ca-43b5-bf90-d8a2e3ed87b2",
"AwardedByFK": "7cf05978-1e6a-45ea-a8f5-845a1d2dd997",
"VerifiedByFk": "3a3673ac-bbd1-472f-96a0-3624cb494d3c",
"Achieved": "2026-04-05T03:35:11.4055258-04:00",
"LastAchieved": "2026-04-05T03:35:11.4055258-04:00",
"ConfirmedOn": "2026-04-05T03:35:11.4055258-04:00",
"Reference": "sample string 3",
"Reason": "sample string 4",
"Accreditation": {
"AccreditationIDPK": "6540cc83-fa6c-4a6b-b5e4-d9f822433622",
"AccreditationTypeFk": "71ff457a-6cb6-4bef-ba86-060f689db0ff",
"AccreditationGroupFK": "aeee988a-ede7-42e3-a2be-dc22d88a176e",
"ReplacementAccreditationFK": "4cf328d4-1686-4a20-8608-e58bb1d28c30",
"CreatedBy": "e8ff6c76-f297-4c0d-8ffa-c7b32d57f592",
"HomeGroup": "e47b55b7-1439-4f66-95e6-167043f9f1f9",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "519e43e7-9cf2-4029-9c11-38a763805792",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "5df4bc15-6908-4605-bc85-6a62a95b993f",
"Expires": "2026-04-05T03:35:11.4055258-04:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2026-04-05T03:35:11.4055258-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": "4f04e5d3-efa3-4058-b6a9-94084eb98613",
"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": "4f04e5d3-efa3-4058-b6a9-94084eb98613",
"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>4241e64e-dd95-455a-97d6-f50fede592b8</AAIdPK>
<AIDFK>43e704c9-4f50-4e92-bc0d-c929b35c8aef</AIDFK>
<Accreditation>
<AccreditationGroupFK>aeee988a-ede7-42e3-a2be-dc22d88a176e</AccreditationGroupFK>
<AccreditationIDPK>6540cc83-fa6c-4a6b-b5e4-d9f822433622</AccreditationIDPK>
<AccreditationTypeFk>71ff457a-6cb6-4bef-ba86-060f689db0ff</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>5df4bc15-6908-4605-bc85-6a62a95b993f</CertificateImageFK>
<Created>2026-04-05T03:35:11.4055258-04:00</Created>
<CreatedBy>e8ff6c76-f297-4c0d-8ffa-c7b32d57f592</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2026-04-05T03:35:11.4055258-04:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>e47b55b7-1439-4f66-95e6-167043f9f1f9</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>519e43e7-9cf2-4029-9c11-38a763805792</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>4cf328d4-1686-4a20-8608-e58bb1d28c30</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
<Achieved>2026-04-05T03:35:11.4055258-04:00</Achieved>
<AwardedByFK>7cf05978-1e6a-45ea-a8f5-845a1d2dd997</AwardedByFK>
<Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon">
<d2p1:UserGUID>4f04e5d3-efa3-4058-b6a9-94084eb98613</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>4f04e5d3-efa3-4058-b6a9-94084eb98613</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>2026-04-05T03:35:11.4055258-04:00</ConfirmedOn>
<LastAchieved>2026-04-05T03:35:11.4055258-04:00</LastAchieved>
<Reason>sample string 4</Reason>
<Reference>sample string 3</Reference>
<UserIdFK>dedc5779-23ca-43b5-bf90-d8a2e3ed87b2</UserIdFK>
<VerifiedByFk>3a3673ac-bbd1-472f-96a0-3624cb494d3c</VerifiedByFk>
</AccreditationsAwarded>