POST classroomAPI/Portal/setAward?UserID={UserID}&AwarderID={AwarderID}&AccreditationID={AccreditationID}&Reason={Reason}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "6f5982db-7eca-4d99-8383-f4f7ca1491ce",
  "AIDFK": "09221603-e258-47bb-b808-3bb2b49a4fe9",
  "UserIdFK": "ffb05a29-3a28-4c91-9904-6fb9bac425e4",
  "AwardedByFK": "6723436e-4dc6-4707-bf29-bde7c09639f6",
  "VerifiedByFk": "fd029a61-fb49-4481-95c7-786de5c50c6d",
  "Achieved": "2025-09-18T17:10:56.1473984-04:00",
  "LastAchieved": "2025-09-18T17:10:56.1473984-04:00",
  "ConfirmedOn": "2025-09-18T17:10:56.1473984-04:00",
  "Reference": "sample string 3",
  "Reason": "sample string 4",
  "Accreditation": {
    "AccreditationIDPK": "4a62b426-ec4f-4a4d-8a11-52b43a8c1185",
    "AccreditationTypeFk": "d192ccec-0cfb-43e8-ada0-32c44f49b5de",
    "AccreditationGroupFK": "b16e3a68-e3f8-4d57-a1f4-8317686f5dda",
    "ReplacementAccreditationFK": "f9d3f7ef-d3c1-4928-a20e-630446507b48",
    "CreatedBy": "546629a0-b5b4-4971-b677-7d8a3d341410",
    "HomeGroup": "ae8b2b6e-b0ed-46f7-a011-642c5c2af2f9",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Category": 1,
    "IncentiveIconFK": "d5243c30-69d6-4530-a8cc-14a549d30df1",
    "IncentiveIcon": "sample string 3",
    "IncentiveText": "sample string 4",
    "NoOfCourses": 1,
    "CertificateImage": "sample string 5",
    "CertificateImageFK": "0b943e3c-c141-4fe1-8b14-6cb447df048b",
    "Expires": "2025-09-18T17:10:56.1473984-04:00",
    "AwardHomePage": 1,
    "Enabled": true,
    "Created": "2025-09-18T17:10:56.1473984-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": "afd09930-a479-4401-ab56-82b964752e96",
    "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": "afd09930-a479-4401-ab56-82b964752e96",
    "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>6f5982db-7eca-4d99-8383-f4f7ca1491ce</AAIdPK>
  <AIDFK>09221603-e258-47bb-b808-3bb2b49a4fe9</AIDFK>
  <Accreditation>
    <AccreditationGroupFK>b16e3a68-e3f8-4d57-a1f4-8317686f5dda</AccreditationGroupFK>
    <AccreditationIDPK>4a62b426-ec4f-4a4d-8a11-52b43a8c1185</AccreditationIDPK>
    <AccreditationTypeFk>d192ccec-0cfb-43e8-ada0-32c44f49b5de</AccreditationTypeFk>
    <AwardHomePage>1</AwardHomePage>
    <Category>1</Category>
    <CertificateImage>sample string 5</CertificateImage>
    <CertificateImageFK>0b943e3c-c141-4fe1-8b14-6cb447df048b</CertificateImageFK>
    <Created>2025-09-18T17:10:56.1473984-04:00</Created>
    <CreatedBy>546629a0-b5b4-4971-b677-7d8a3d341410</CreatedBy>
    <Description>sample string 2</Description>
    <Enabled>true</Enabled>
    <Expires>2025-09-18T17:10:56.1473984-04:00</Expires>
    <ExternalRef>sample string 8</ExternalRef>
    <HomeGroup>ae8b2b6e-b0ed-46f7-a011-642c5c2af2f9</HomeGroup>
    <IncentiveIcon>sample string 3</IncentiveIcon>
    <IncentiveIconFK>d5243c30-69d6-4530-a8cc-14a549d30df1</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>f9d3f7ef-d3c1-4928-a20e-630446507b48</ReplacementAccreditationFK>
    <URL>sample string 6</URL>
  </Accreditation>
  <Achieved>2025-09-18T17:10:56.1473984-04:00</Achieved>
  <AwardedByFK>6723436e-4dc6-4707-bf29-bde7c09639f6</AwardedByFK>
  <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon">
    <d2p1:UserGUID>afd09930-a479-4401-ab56-82b964752e96</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>afd09930-a479-4401-ab56-82b964752e96</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-09-18T17:10:56.1473984-04:00</ConfirmedOn>
  <LastAchieved>2025-09-18T17:10:56.1473984-04:00</LastAchieved>
  <Reason>sample string 4</Reason>
  <Reference>sample string 3</Reference>
  <UserIdFK>ffb05a29-3a28-4c91-9904-6fb9bac425e4</UserIdFK>
  <VerifiedByFk>fd029a61-fb49-4481-95c7-786de5c50c6d</VerifiedByFk>
</AccreditationsAwarded>