GET userinfo/GetUserAuthentication?username={username}&password={password}&clientId={clientId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| username | string |
Required |
|
| password | string |
Required |
|
| clientId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
UserInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| TypeId | integer |
None. |
|
| Password | string |
None. |
|
| CreditUsed | integer |
None. |
|
| CreateBy | string |
None. |
|
| CreateDate | date |
None. |
|
| UserCode | string |
None. |
|
| SchoolId | integer |
None. |
|
| EmailId | string |
None. |
|
| ClassId | integer |
None. |
|
| PlayerLog | string |
None. |
|
| UserId | integer |
None. |
|
| OldPassword | string |
None. |
|
| UserName | string |
None. |
|
| Gender | string |
None. |
|
| IsAuthenticated | boolean |
None. |
|
| LastLogIn | date |
None. |
|
| WebServiceResult | string |
None. |
|
| DateOfBirth | date |
None. |
|
| UserAddress | string |
None. |
|
| PostalCode | string |
None. |
|
| ProfilePicture | Collection of byte |
None. |
|
| SecurityToken | string |
None. |
|
| DisplayName | string |
None. |
|
| userStatus | integer |
None. |
|
| LastUpdatedBy | string |
None. |
|
| VerifyByEmailToggle | boolean |
None. |
|
| IsEmailVerified | boolean |
None. |
|
| EmailVerifyToken | string |
None. |
|
| EmailVerifyTokenIssuedOn | date |
None. |
|
| EmailVerifiedOn | date |
None. |
|
| UserClassInformations | Collection of UserClassInformation |
None. |
|
| UserType | UserType |
None. |
|
| UserInfoExtensions | Collection of UserInfoExtension |
None. |
Response Formats
application/json, text/json
Sample:
{
"TypeId": 1,
"Password": "sample string 2",
"CreditUsed": 3,
"CreateBy": "sample string 4",
"CreateDate": "2025-12-09T00:53:11.908489+00:00",
"UserCode": "sample string 6",
"SchoolId": 7,
"EmailId": "sample string 8",
"ClassId": 9,
"PlayerLog": "sample string 10",
"UserId": 11,
"OldPassword": "sample string 12",
"UserName": "sample string 13",
"Gender": "sample string 14",
"IsAuthenticated": true,
"LastLogIn": "2025-12-09T00:53:11.908489+00:00",
"WebServiceResult": "sample string 17",
"DateOfBirth": "2025-12-09T00:53:11.908489+00:00",
"UserAddress": "sample string 19",
"PostalCode": "sample string 20",
"ProfilePicture": "QEA=",
"SecurityToken": "sample string 21",
"DisplayName": "sample string 22",
"userStatus": 1,
"LastUpdatedBy": "sample string 23",
"VerifyByEmailToggle": true,
"IsEmailVerified": true,
"EmailVerifyToken": "sample string 24",
"EmailVerifyTokenIssuedOn": "2025-12-09T00:53:11.9241349+00:00",
"EmailVerifiedOn": "2025-12-09T00:53:11.9241349+00:00",
"UserClassInformations": [
{
"$id": "2",
"UserId": 1,
"ClassId": 2,
"IsActive": true,
"Class": {
"$id": "3",
"ClassId": 1,
"ClassCode": "sample string 2",
"ClassName": "sample string 3",
"Password": "sample string 4",
"CreateDate": "2025-12-09T00:53:11.9241349+00:00",
"SchoolId": 6,
"TeacherId": 7,
"IsMultiPlayer": true,
"ClientGuiFilePath": "sample string 8",
"ClientGuiLastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"MobileClientGuiFilePath": "sample string 9",
"MobileClientGuiLastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"StartDate": "2025-12-09T00:53:11.9241349+00:00",
"EndDate": "2025-12-09T00:53:11.9241349+00:00",
"Chapters": [
{
"$id": "4",
"ChapterId": 1,
"ClassId": 2,
"ChapterName": "sample string 3",
"ChapterDescription": "sample string 4",
"ReferenceNo": "sample string 5",
"MediaFilePath": "sample string 6",
"IsActive": true,
"CreatedBy": "sample string 8",
"CreatedDate": "2025-12-09T00:53:11.9241349+00:00",
"LastUpdatedBy": "sample string 10",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"IconImageId": 1,
"PhaseType": 1,
"PhaseChapterId": 1,
"Sequence": 1,
"IsMultiplayer": true,
"ClientGuiFilePath": "sample string 12",
"ClientGuiLastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"MobileClientGuiFilePath": "sample string 13",
"MobileClientGuiLastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"Class": {
"$ref": "3"
},
"Image": {
"$id": "5",
"ImageId": 1,
"ImgFilePath": "sample string 2",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"Chapters": [
{
"$ref": "4"
},
{
"$ref": "4"
}
],
"SinglePlayerGameSchedules": [
{
"$id": "6",
"BookingId": 1,
"ChapterId": 2,
"UpdateStatusId": 3,
"ClassId": 4,
"TeacherId": 5,
"ScheduleDate": "2025-12-09T00:53:11.9241349+00:00",
"StartDate": "2025-12-09T00:53:11.9241349+00:00",
"EndDate": "2025-12-09T00:53:11.9241349+00:00",
"GameName": "sample string 9",
"GameDescription": "sample string 10",
"FileName": "sample string 11",
"ReferenceNo": "sample string 12",
"MediaFilePath": "sample string 13",
"LogFilePath": "sample string 14",
"LastUpdatedBy": "sample string 15",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"GameIconId": 1,
"PhasedGameId": 1,
"PersistentItemsRequired": true,
"PersistentItemsDesc": "sample string 17",
"IsMultiplayer": true,
"MaxRoomsAllowed": 1,
"GameScore": 1,
"sequence": 1,
"PlayersPerRoom": 1,
"QuorumPerRoom": 1,
"GamePlayReqdAtClassLevel": 1,
"GamePlayReqdAtChapterLevel": 1,
"Chapter": {
"$ref": "4"
},
"Class": {
"$ref": "3"
},
"Image": {
"$ref": "5"
},
"PersistentItemsCollecteds": [
{
"$id": "7",
"UserId": 1,
"GameId": 2,
"ItemId": "sample string 3",
"UpdateTime": "2025-12-09T00:53:11.9241349+00:00",
"Qty": 5,
"SinglePlayerGameSchedule": {
"$ref": "6"
}
},
{
"$ref": "7"
}
],
"SinglePlayerGameSchedule1": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"SinglePlayerGameSchedule2": {
"$ref": "6"
},
"UpdateStatu": {
"$id": "8",
"UpdateStatusId": 1,
"UpdateStatusName": "sample string 2",
"UpdateStatusDescription": "sample string 3",
"IsActive": true,
"SinglePlayerGameSchedules": [
{
"$ref": "6"
},
{
"$ref": "6"
}
]
},
"LocalizedGameSchedules": [
{
"$id": "9",
"LocalizedBookingId": 1,
"BookingId": 2,
"LanguageId": 3,
"GameName": "sample string 4",
"GameDescription": "sample string 5",
"ReferenceNo": "sample string 6",
"MediaFilePath": "sample string 7",
"GameIconId": 1,
"LogFilePath": "sample string 8",
"CreateddBy": "sample string 9",
"CreatedDate": "2025-12-09T00:53:11.9241349+00:00",
"LastUpdatedBy": "sample string 11",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"IsActive": true,
"Image": {
"$ref": "5"
},
"Language": {
"$id": "10",
"LanguageId": 1,
"LanguageCode": "sample string 2",
"Name": "sample string 3",
"LanguageUnicode": "sample string 4",
"DisplayLanguage": "sample string 5",
"LanguageIsoCode": "sample string 6",
"LocaleIsoCode": "sample string 7",
"LocaleName": "sample string 8",
"DateTimeFormat": "sample string 9",
"ThosandSeparator": 1,
"IsAvailableInClientUI": true,
"IsActive": true,
"CreatedBy": "sample string 11",
"CreatedDate": "2025-12-09T00:53:11.9241349+00:00",
"LastUpdatedBy": "sample string 13",
"LastUpdateDate": "2025-12-09T00:53:11.9241349+00:00",
"LocalizedClasses": [
{
"$id": "11",
"LocalizedClassId": 1,
"ClassId": 2,
"LanguageId": 3,
"ClassName": "sample string 4",
"ClassDescription": "sample string 5",
"IconImageId": 1,
"IsActive": true,
"CreatedBy": "sample string 7",
"CreatedDate": "2025-12-09T00:53:11.9241349+00:00",
"LastUpdatedBy": "sample string 9",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"Class": {
"$ref": "3"
},
"Language": {
"$ref": "10"
}
},
{
"$ref": "11"
}
],
"LocalizedChapters": [
{
"$id": "12",
"LocalizedChapterId": 1,
"ChapterId": 2,
"LanguageId": 3,
"ChapterName": "sample string 4",
"ChapterDescription": "sample string 5",
"MediaFilePath": "sample string 6",
"ClientGuiFilePath": "sample string 7",
"ClientGuiLastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"IconImageId": 1,
"IsActive": true,
"CreatedBy": "sample string 9",
"CreatedDate": "2025-12-09T00:53:11.9241349+00:00",
"LastUpdatedBy": "sample string 11",
"LastUpdatedDate": "2025-12-09T00:53:11.9241349+00:00",
"Chapter": {
"$ref": "4"
},
"Image": {
"$ref": "5"
},
"Language": {
"$ref": "10"
}
},
{
"$ref": "12"
}
],
"LocalizedGameSchedules": [
{
"$ref": "9"
},
{
"$ref": "9"
}
]
},
"SinglePlayerGameSchedule": {
"$ref": "6"
}
},
{
"$ref": "9"
}
]
},
{
"$ref": "6"
}
],
"LocalizedChapters": [
{
"$ref": "12"
},
{
"$ref": "12"
}
],
"LocalizedGameSchedules": [
{
"$ref": "9"
},
{
"$ref": "9"
}
]
},
"Chapter1": [
{
"$ref": "4"
},
{
"$ref": "4"
}
],
"Chapter2": {
"$ref": "4"
},
"SinglePlayerGameSchedules": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"LocalizedChapters": [
{
"$ref": "12"
},
{
"$ref": "12"
}
]
},
{
"$ref": "4"
}
],
"SinglePlayerGameSchedules": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"UserClassInformations": [
{
"$ref": "2"
},
{
"$ref": "2"
}
],
"LocalizedClasses": [
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"UserInfo": {
"$ref": "1"
}
},
{
"$ref": "2"
}
],
"UserType": {
"$id": "13",
"TypeId": 1,
"TypeName": "sample string 2",
"UserInfoes": [
{
"$ref": "1"
},
{
"$ref": "1"
}
]
},
"UserInfoExtensions": [
{
"$id": "14",
"UserInfoExtensionId": 1,
"UserId": 2,
"Industry": "sample string 3",
"Company": "sample string 4",
"Profession": "sample string 5",
"GroupLevel": "sample string 6",
"Department": "sample string 7",
"Division": "sample string 8",
"Message": "sample string 9",
"Email": "sample string 10",
"FullName": "sample string 11",
"IdentityNumber": "sample string 12",
"IdentityType": "sample string 13",
"MobilePhone": "sample string 14",
"MobileType": "sample string 15",
"Nationality": "sample string 16",
"Avatar": "sample string 17",
"LocalExperience": "sample string 18",
"PlayedGamesBefore": true,
"LikeToPlayGames": true,
"JointAccounts": 1,
"CreatedBy": "sample string 19",
"CreatedDate": "2025-12-09T00:53:11.9397558+00:00",
"LastUpdatedBy": "sample string 21",
"LastUpdatedDate": "2025-12-09T00:53:11.9397558+00:00",
"Cohort": "sample string 23",
"UserInfo": {
"$ref": "1"
}
},
{
"$ref": "14"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
multipart/form-data
Sample:
Sample not available.