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": "72f9f997-e26d-4c6d-8471-5fb05be9b88e", "AIDFK": "3f3b5e1f-a685-4ad9-8c04-07de2d56b43a", "UserIdFK": "a6e4ab6f-0e1a-4c40-b1d6-7d07b8867fe3", "AwardedByFK": "ec0e2b3e-b7b3-49ac-9070-969f2a3b191c", "VerifiedByFk": "552b1b7a-47d0-4640-8102-26a3105df5bd", "Achieved": "2024-11-25T04:55:01.4637612-05:00", "LastAchieved": "2024-11-25T04:55:01.4637612-05:00", "ConfirmedOn": "2024-11-25T04:55:01.4637612-05:00", "Reference": "sample string 3", "Reason": "sample string 4", "Accreditation": { "AccreditationIDPK": "f3560fd4-d98e-4420-92a9-d8936922d532", "AccreditationTypeFk": "2c6844ea-36f7-49b3-b473-861530720dc9", "AccreditationGroupFK": "0f9a6fb8-b712-4815-b69a-e5348425d00e", "ReplacementAccreditationFK": "3ce29eca-5318-4fc1-826c-8a168894af6f", "CreatedBy": "4d7e0abf-bcaf-43e3-93d4-df8c9e20c464", "HomeGroup": "143c2646-6f26-4216-a018-516437998f57", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "4b7187d3-46b9-452a-bc56-d7ff32a3746c", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "69de1dc5-fdcb-4d41-a6e5-d81a405a0e51", "Expires": "2024-11-25T04:55:01.4637612-05:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-11-25T04:55:01.4637612-05: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": "d863ecce-5288-4d7c-9f0c-9116a7c3b517", "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": "d863ecce-5288-4d7c-9f0c-9116a7c3b517", "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>72f9f997-e26d-4c6d-8471-5fb05be9b88e</AAIdPK> <AIDFK>3f3b5e1f-a685-4ad9-8c04-07de2d56b43a</AIDFK> <Accreditation> <AccreditationGroupFK>0f9a6fb8-b712-4815-b69a-e5348425d00e</AccreditationGroupFK> <AccreditationIDPK>f3560fd4-d98e-4420-92a9-d8936922d532</AccreditationIDPK> <AccreditationTypeFk>2c6844ea-36f7-49b3-b473-861530720dc9</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>69de1dc5-fdcb-4d41-a6e5-d81a405a0e51</CertificateImageFK> <Created>2024-11-25T04:55:01.4637612-05:00</Created> <CreatedBy>4d7e0abf-bcaf-43e3-93d4-df8c9e20c464</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-11-25T04:55:01.4637612-05:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>143c2646-6f26-4216-a018-516437998f57</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>4b7187d3-46b9-452a-bc56-d7ff32a3746c</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>3ce29eca-5318-4fc1-826c-8a168894af6f</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Achieved>2024-11-25T04:55:01.4637612-05:00</Achieved> <AwardedByFK>ec0e2b3e-b7b3-49ac-9070-969f2a3b191c</AwardedByFK> <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>d863ecce-5288-4d7c-9f0c-9116a7c3b517</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>d863ecce-5288-4d7c-9f0c-9116a7c3b517</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-11-25T04:55:01.4637612-05:00</ConfirmedOn> <LastAchieved>2024-11-25T04:55:01.4637612-05:00</LastAchieved> <Reason>sample string 4</Reason> <Reference>sample string 3</Reference> <UserIdFK>a6e4ab6f-0e1a-4c40-b1d6-7d07b8867fe3</UserIdFK> <VerifiedByFk>552b1b7a-47d0-4640-8102-26a3105df5bd</VerifiedByFk> </AccreditationsAwarded>