GET api/User?userId={userId}&contextIdentifier={contextIdentifier}
Gets information about user in context of specific identifier (profile scope required)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId |
User id that is returned in loging process. |
globally unique identifier |
Required |
| contextIdentifier |
Institution or Organization context |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns user details in context of account and identifier
UserDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Username | string |
None. |
|
| FullName | string |
None. |
|
| string |
None. |
||
| Message | string |
None. |
|
| UserId | globally unique identifier |
None. |
|
| InstitutionId | globally unique identifier |
None. |
|
| ClassId | globally unique identifier |
None. |
|
| InstitutionName | string |
None. |
|
| InstitutionNumber | string |
None. |
|
| TypeId | string |
None. |
|
| TypeName | string |
None. |
|
| UserRole | string |
None. |
|
| UserRoleId | globally unique identifier |
None. |
|
| Level | string |
None. |
|
| PhysicalMunicipalityName | string |
None. |
|
| PhysicalMunicipalityNumber | string |
None. |
|
| AdministrativeMunicipalityName | string |
None. |
|
| AdministrativeMunicipalityNumber | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<UserDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses"> <AdministrativeMunicipalityName>sample string 16</AdministrativeMunicipalityName> <AdministrativeMunicipalityNumber>sample string 17</AdministrativeMunicipalityNumber> <ClassId>55d42996-173e-44c7-b611-e42b902e3c7a</ClassId> <InstitutionId>a55b0f2c-3b8b-454d-94c1-1ec7049e2c76</InstitutionId> <InstitutionName>sample string 8</InstitutionName> <InstitutionNumber>sample string 9</InstitutionNumber> <Level>sample string 13</Level> <Message>sample string 6</Message> <PhysicalMunicipalityName>sample string 14</PhysicalMunicipalityName> <PhysicalMunicipalityNumber>sample string 15</PhysicalMunicipalityNumber> <TypeId>sample string 10</TypeId> <TypeName>sample string 11</TypeName> <UserId>e27b5653-9be0-484d-b0c2-c9c3f9741153</UserId> <UserRole>sample string 12</UserRole> <UserRoleId>62088c58-765f-4925-b76c-381add377e3d</UserRoleId> <Email>sample string 5</Email> <FirstName>sample string 1</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 2</LastName> <Username>sample string 3</Username> </UserDetailsResponse>
application/json, text/json
Sample:
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Username": "sample string 3",
"FullName": "sample string 4",
"Email": "sample string 5",
"Message": "sample string 6",
"UserId": "e27b5653-9be0-484d-b0c2-c9c3f9741153",
"InstitutionId": "a55b0f2c-3b8b-454d-94c1-1ec7049e2c76",
"ClassId": "55d42996-173e-44c7-b611-e42b902e3c7a",
"InstitutionName": "sample string 8",
"InstitutionNumber": "sample string 9",
"TypeId": "sample string 10",
"TypeName": "sample string 11",
"UserRole": "sample string 12",
"UserRoleId": "62088c58-765f-4925-b76c-381add377e3d",
"Level": "sample string 13",
"PhysicalMunicipalityName": "sample string 14",
"PhysicalMunicipalityNumber": "sample string 15",
"AdministrativeMunicipalityName": "sample string 16",
"AdministrativeMunicipalityNumber": "sample string 17"
}