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": "2c69c761-908b-468d-92cc-2ac449094276", "AIDFK": "f26caf28-0c2b-4df6-980a-6b270b7756f0", "UserIdFK": "0e15e10c-7812-486b-a06e-1086a4d314fd", "AwardedByFK": "b0e5cafb-84a5-44db-9fb5-799a606e98c2", "VerifiedByFk": "f2c2d580-f502-4887-8d02-dd23bb14ce1b", "Achieved": "2024-09-28T13:06:10.999607+00:00", "LastAchieved": "2024-09-28T13:06:10.999607+00:00", "ConfirmedOn": "2024-09-28T13:06:10.999607+00:00", "Reference": "sample string 3", "Reason": "sample string 4", "Accreditation": { "AccreditationIDPK": "8641c3e6-f51a-426b-b79b-a5aac4d340f3", "AccreditationTypeFk": "b16ee156-5ee1-4df0-8ef2-bac4b75e54fb", "AccreditationGroupFK": "4652a34a-7420-4b4b-9dc4-29bac2f8a8d7", "ReplacementAccreditationFK": "9f1a440f-15a8-4e16-a289-af45fd0bdf6a", "CreatedBy": "b9390bb4-c01b-4311-8b23-be978903a01f", "HomeGroup": "906f3c74-aa2c-4eb5-9080-7e23442b82f9", "Name": "sample string 1", "Description": "sample string 2", "Category": 1, "IncentiveIconFK": "882d18b6-8d31-4a35-b47b-1cf1fbd1d0ea", "IncentiveIcon": "sample string 3", "IncentiveText": "sample string 4", "NoOfCourses": 1, "CertificateImage": "sample string 5", "CertificateImageFK": "a9014497-c1bb-41a1-bca2-d5ff1097438f", "Expires": "2024-09-28T13:06:10.999607+00:00", "AwardHomePage": 1, "Enabled": true, "Created": "2024-09-28T13:06:10.999607+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": "d25d2568-7286-49a2-816e-f69493ad1ff0", "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": "d25d2568-7286-49a2-816e-f69493ad1ff0", "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>2c69c761-908b-468d-92cc-2ac449094276</AAIdPK> <AIDFK>f26caf28-0c2b-4df6-980a-6b270b7756f0</AIDFK> <Accreditation> <AccreditationGroupFK>4652a34a-7420-4b4b-9dc4-29bac2f8a8d7</AccreditationGroupFK> <AccreditationIDPK>8641c3e6-f51a-426b-b79b-a5aac4d340f3</AccreditationIDPK> <AccreditationTypeFk>b16ee156-5ee1-4df0-8ef2-bac4b75e54fb</AccreditationTypeFk> <AwardHomePage>1</AwardHomePage> <Category>1</Category> <CertificateImage>sample string 5</CertificateImage> <CertificateImageFK>a9014497-c1bb-41a1-bca2-d5ff1097438f</CertificateImageFK> <Created>2024-09-28T13:06:10.999607+00:00</Created> <CreatedBy>b9390bb4-c01b-4311-8b23-be978903a01f</CreatedBy> <Description>sample string 2</Description> <Enabled>true</Enabled> <Expires>2024-09-28T13:06:10.999607+00:00</Expires> <ExternalRef>sample string 8</ExternalRef> <HomeGroup>906f3c74-aa2c-4eb5-9080-7e23442b82f9</HomeGroup> <IncentiveIcon>sample string 3</IncentiveIcon> <IncentiveIconFK>882d18b6-8d31-4a35-b47b-1cf1fbd1d0ea</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>9f1a440f-15a8-4e16-a289-af45fd0bdf6a</ReplacementAccreditationFK> <URL>sample string 6</URL> </Accreditation> <Achieved>2024-09-28T13:06:10.999607+00:00</Achieved> <AwardedByFK>b0e5cafb-84a5-44db-9fb5-799a606e98c2</AwardedByFK> <Awardee xmlns:d2p1="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon"> <d2p1:UserGUID>d25d2568-7286-49a2-816e-f69493ad1ff0</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>d25d2568-7286-49a2-816e-f69493ad1ff0</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-28T13:06:10.999607+00:00</ConfirmedOn> <LastAchieved>2024-09-28T13:06:10.999607+00:00</LastAchieved> <Reason>sample string 4</Reason> <Reference>sample string 3</Reference> <UserIdFK>0e15e10c-7812-486b-a06e-1086a4d314fd</UserIdFK> <VerifiedByFk>f2c2d580-f502-4887-8d02-dd23bb14ce1b</VerifiedByFk> </AccreditationsAwarded>