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": "90806fcd-9187-42b4-815b-d0a4ed0a83fc", "AIDFK": "638cf335-1dd3-498d-bdfa-71dc6bef0c74", "UserIdFK": "4c30423f-f7e1-47d5-a234-6ad7c84e0af3", "AwardedByFK": "70b0feba-e384-4703-bce4-3cec2ce7092c", "VerifiedByFk": "cdc94c5b-2ff2-4941-806f-01af3b131a6a", "Achieved": "2024-09-19T14:57:12.124799-04:00", "LastAchieved": "2024-09-19T14:57:12.124799-04:00", "ConfirmedOn": "2024-09-19T14:57:12.124799-04:00", "Reference": "sample string 3", "Reason": "sample string 4", "Accreditation": { "AccreditationIDPK": "40bc2d83-ab4e-4a98-bc3e-0a5bad00dcfb", "AccreditationTypeFk": "f5df1fda-6ebb-4d70-95b6-e6384e069455", "AccreditationGroupFK": "84239baa-08e6-4014-a173-2214b9391dc3", "ReplacementAccreditationFK": "98c583f2-67f1-4941-9917-d7505e496206", "CreatedBy": "f7f2282b-3c8e-4104-bab8-89198ec2c76c", "HomeGroup": "17ed1ca2-2783-4308-bd83-44cfbf74bc74", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "68909ad4-b66f-43b0-8231-ea3e007d5197", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "069f9e48-bc34-437e-a226-d6ac60eb697f", "Expires": "2024-09-19T14:57:12.124799-04:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-09-19T14:57:12.124799-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": "5d5b969d-eaa4-4f02-80c4-53ed6abb189a", "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": "5d5b969d-eaa4-4f02-80c4-53ed6abb189a", "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>90806fcd-9187-42b4-815b-d0a4ed0a83fc</AAIdPK> <AIDFK>638cf335-1dd3-498d-bdfa-71dc6bef0c74</AIDFK> <Accreditation> <AccreditationGroupFK>84239baa-08e6-4014-a173-2214b9391dc3</AccreditationGroupFK> <AccreditationIDPK>40bc2d83-ab4e-4a98-bc3e-0a5bad00dcfb</AccreditationIDPK> <AccreditationTypeFk>f5df1fda-6ebb-4d70-95b6-e6384e069455</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>069f9e48-bc34-437e-a226-d6ac60eb697f</CertificateImageFK> <Created>2024-09-19T14:57:12.124799-04:00</Created> <CreatedBy>f7f2282b-3c8e-4104-bab8-89198ec2c76c</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-09-19T14:57:12.124799-04:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>17ed1ca2-2783-4308-bd83-44cfbf74bc74</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>68909ad4-b66f-43b0-8231-ea3e007d5197</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>98c583f2-67f1-4941-9917-d7505e496206</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Achieved>2024-09-19T14:57:12.124799-04:00</Achieved> <AwardedByFK>70b0feba-e384-4703-bce4-3cec2ce7092c</AwardedByFK> <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>5d5b969d-eaa4-4f02-80c4-53ed6abb189a</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>5d5b969d-eaa4-4f02-80c4-53ed6abb189a</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-09-19T14:57:12.124799-04:00</ConfirmedOn> <LastAchieved>2024-09-19T14:57:12.124799-04:00</LastAchieved> <Reason>sample string 4</Reason> <Reference>sample string 3</Reference> <UserIdFK>4c30423f-f7e1-47d5-a234-6ad7c84e0af3</UserIdFK> <VerifiedByFk>cdc94c5b-2ff2-4941-806f-01af3b131a6a</VerifiedByFk> </AccreditationsAwarded>