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": "a52d6dd7-6b71-46d8-890c-6b0b7511278b",
"AIDFK": "99849af1-ffbc-4b8c-99c1-93cc57ba1a40",
"UserIdFK": "2ea8471c-f002-450d-8453-d8cd94eb2832",
"AwardedByFK": "287913b1-4229-41f2-b967-96610272f328",
"VerifiedByFk": "3cfaebf7-f967-47d2-9350-a2e1b082540d",
"Achieved": "2026-06-01T13:44:35.1021702-04:00",
"LastAchieved": "2026-06-01T13:44:35.1021702-04:00",
"ConfirmedOn": "2026-06-01T13:44:35.1021702-04:00",
"Reference": "sample string 3",
"Reason": "sample string 4",
"Accreditation": {
"AccreditationIDPK": "950d8c9f-1a05-46df-a63c-c9a9fb29ec8f",
"AccreditationTypeFk": "57724a17-b093-4d64-8017-ccfe4c78f01a",
"AccreditationGroupFK": "5dd24afa-1e3b-449c-b5dd-d7571f21cef2",
"ReplacementAccreditationFK": "783e3492-8db0-44d4-9b39-b401390e7697",
"CreatedBy": "69aae81a-3f47-4a73-ac28-7618180b2507",
"HomeGroup": "a8cb4999-dbce-4007-950e-25c58a24a80a",
"Name": "sample string 1",
"Description": "sample string 2",
"Category": 1,
"IncentiveIconFK": "85568c6f-555c-4c86-8465-34dd7fdba376",
"IncentiveIcon": "sample string 3",
"IncentiveText": "sample string 4",
"NoOfCourses": 1,
"CertificateImage": "sample string 5",
"CertificateImageFK": "3391ae5d-5105-4933-9847-ed7f15e6b166",
"Expires": "2026-06-01T13:44:35.1021702-04:00",
"AwardHomePage": 1,
"Enabled": true,
"Created": "2026-06-01T13:44:35.1021702-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": "cea80ef9-f710-4bc8-8056-a79b94083bb6",
"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": "cea80ef9-f710-4bc8-8056-a79b94083bb6",
"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>a52d6dd7-6b71-46d8-890c-6b0b7511278b</AAIdPK>
<AIDFK>99849af1-ffbc-4b8c-99c1-93cc57ba1a40</AIDFK>
<Accreditation>
<AccreditationGroupFK>5dd24afa-1e3b-449c-b5dd-d7571f21cef2</AccreditationGroupFK>
<AccreditationIDPK>950d8c9f-1a05-46df-a63c-c9a9fb29ec8f</AccreditationIDPK>
<AccreditationTypeFk>57724a17-b093-4d64-8017-ccfe4c78f01a</AccreditationTypeFk>
<AwardHomePage>1</AwardHomePage>
<Category>1</Category>
<CertificateImage>sample string 5</CertificateImage>
<CertificateImageFK>3391ae5d-5105-4933-9847-ed7f15e6b166</CertificateImageFK>
<Created>2026-06-01T13:44:35.1021702-04:00</Created>
<CreatedBy>69aae81a-3f47-4a73-ac28-7618180b2507</CreatedBy>
<Description>sample string 2</Description>
<Enabled>true</Enabled>
<Expires>2026-06-01T13:44:35.1021702-04:00</Expires>
<ExternalRef>sample string 8</ExternalRef>
<HomeGroup>a8cb4999-dbce-4007-950e-25c58a24a80a</HomeGroup>
<IncentiveIcon>sample string 3</IncentiveIcon>
<IncentiveIconFK>85568c6f-555c-4c86-8465-34dd7fdba376</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>783e3492-8db0-44d4-9b39-b401390e7697</ReplacementAccreditationFK>
<URL>sample string 6</URL>
</Accreditation>
<Achieved>2026-06-01T13:44:35.1021702-04:00</Achieved>
<AwardedByFK>287913b1-4229-41f2-b967-96610272f328</AwardedByFK>
<Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon">
<d2p1:UserGUID>cea80ef9-f710-4bc8-8056-a79b94083bb6</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>cea80ef9-f710-4bc8-8056-a79b94083bb6</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-06-01T13:44:35.1021702-04:00</ConfirmedOn>
<LastAchieved>2026-06-01T13:44:35.1021702-04:00</LastAchieved>
<Reason>sample string 4</Reason>
<Reference>sample string 3</Reference>
<UserIdFK>2ea8471c-f002-450d-8453-d8cd94eb2832</UserIdFK>
<VerifiedByFk>3cfaebf7-f967-47d2-9350-a2e1b082540d</VerifiedByFk>
</AccreditationsAwarded>