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": "67f0c275-46a0-4130-9dcd-1a34a6e2ff1a", "AIDFK": "fbbf216a-6884-4d40-975b-ea4c7a6a4ee1", "UserIdFK": "51588cf4-5b51-4a9d-bf46-c3f85e54c3d0", "AwardedByFK": "d338ad1f-d3b9-4b5a-be39-edd67a4b9f59", "VerifiedByFk": "abb9b2de-0f12-45aa-89bc-6f1c3f55654f", "Achieved": "2024-06-28T00:03:41.5056228+00:00", "LastAchieved": "2024-06-28T00:03:41.5056228+00:00", "ConfirmedOn": "2024-06-28T00:03:41.5056228+00:00", "Reference": "sample string 3", "Reason": "sample string 4", "Accreditation": { "AccreditationIDPK": "d458a027-3c61-4742-86ff-c1ebe72daf56", "AccreditationTypeFk": "b753aeb8-d740-4ece-bdff-85e22ebaa71c", "AccreditationGroupFK": "66ce6db6-621e-4941-9367-c0d20d5fdc72", "ReplacementAccreditationFK": "8a2a0013-47d2-4b82-97c4-b4088767e3b5", "CreatedBy": "86abd344-b71b-453d-ac24-0f71c8ac3e16", "HomeGroup": "01bcb20e-780f-4157-8511-0fe9877ea665", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "608f0df0-492c-4280-962f-9af4f5c7c8aa", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "e911f1e5-2d2d-4eb8-a849-82577ba21b1b", "Expires": "2024-06-28T00:03:41.5056228+00:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-06-28T00:03:41.5056228+00: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": "489a0589-252b-47ef-9851-4e06f0b95efb", "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": "489a0589-252b-47ef-9851-4e06f0b95efb", "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>67f0c275-46a0-4130-9dcd-1a34a6e2ff1a</AAIdPK> <AIDFK>fbbf216a-6884-4d40-975b-ea4c7a6a4ee1</AIDFK> <Accreditation> <AccreditationGroupFK>66ce6db6-621e-4941-9367-c0d20d5fdc72</AccreditationGroupFK> <AccreditationIDPK>d458a027-3c61-4742-86ff-c1ebe72daf56</AccreditationIDPK> <AccreditationTypeFk>b753aeb8-d740-4ece-bdff-85e22ebaa71c</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>e911f1e5-2d2d-4eb8-a849-82577ba21b1b</CertificateImageFK> <Created>2024-06-28T00:03:41.5056228+00:00</Created> <CreatedBy>86abd344-b71b-453d-ac24-0f71c8ac3e16</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-06-28T00:03:41.5056228+00:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>01bcb20e-780f-4157-8511-0fe9877ea665</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>608f0df0-492c-4280-962f-9af4f5c7c8aa</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>8a2a0013-47d2-4b82-97c4-b4088767e3b5</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Achieved>2024-06-28T00:03:41.5056228+00:00</Achieved> <AwardedByFK>d338ad1f-d3b9-4b5a-be39-edd67a4b9f59</AwardedByFK> <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>489a0589-252b-47ef-9851-4e06f0b95efb</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>489a0589-252b-47ef-9851-4e06f0b95efb</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>2024-06-28T00:03:41.5056228+00:00</ConfirmedOn> <LastAchieved>2024-06-28T00:03:41.5056228+00:00</LastAchieved> <Reason>sample string 4</Reason> <Reference>sample string 3</Reference> <UserIdFK>51588cf4-5b51-4a9d-bf46-c3f85e54c3d0</UserIdFK> <VerifiedByFk>abb9b2de-0f12-45aa-89bc-6f1c3f55654f</VerifiedByFk> </AccreditationsAwarded>