Skip to content

Ubi Account Management Protocol

Yannik Marchand edited this page Jan 27, 2021 · 1 revision

NEX Protocols > Ubi Account Management (29)

Method ID Method Name
1 CreateAccount
2 UpdateAccount
3 GetAccount
4 LinkAccount
5 GetTOS
6 ValidateUsername
7 ValidatePassword
8 ValidateEmail
9 GetCountryList
10 ForgetPassword
11 LookupPrincipalIds
12 LookupUbiAccountIDsByPids
13 LookupUbiAccountIDsByUsernames
14 LookupUsernamesByUbiAccountIDs
15 LookupUbiAccountIDsByUsernameSubString
16 UserHasPlayed
17 IsUserPlaying
18 LookupUbiAccountIDsByUsernamesGlobal
19 LookupUbiAccountIDsByEmailsGlobal
20 LookupUsernamesByUbiAccountIDsGlobal
21 GetTOSEx
22 HasAcceptedLatestTOS
23 AcceptLatestTOS

(1) CreateAccount

Request

This method does not take any parameters.

Response

Type Name
UbiAccount ubiAccount
List<ValidationFailureReason> failedReasons

(2) UpdateAccount

Request

This method does not take any parameters.

Response

Type Name
UbiAccount ubiAccount
List<ValidationFailureReason> failedReasons

(3) GetAccount

Request

This method does not take any parameters.

Response

Type Name
UbiAccount ubiAccount
Bool exists

(4) LinkAccount

Request

Type Name
String ubiAccountUsername
String ubiAccountPassword

Response

This method does not return anything.

(5) GetTOS

Request

Type Name
String countryCode
String languageCode
Bool htmlVersion

Response

Type Name
TOS tos

(6) ValidateUsername

Request

Type Name
String username

Response

Type Name
UsernameValidation usernameValidation

(7) ValidatePassword

Request

Type Name
String password
String username

Response

Type Name
List<ValidationFailureReason> failedReasons

(8) ValidateEmail

Request

Type Name
String email

Response

Type Name
List<ValidationFailureReason> failedReasons

(9) GetCountryList

Request

Type Name
String languageCode

Response

Type Name
List<Country> countries

(10) ForgetPassword

Request

Type Name
String usernameOrEmail

Response

This method does not return anything.

(11) LookupPrincipalIds

Request

Type Name
List<String> ubiAccountIds

Response

Type Name
Map<String, Uint32> pids

(12) LookupUbiAccountIDsByPids

Request

Type Name
List<Uint32> pids

Response

Type Name
Map<Uint32, String> ubiaccountIDs

(13) LookupUbiAccountIDsByUsernames

Request

Type Name
List<String> Usernames

Response

Type Name
Map<String, String> UbiAccountIDs

(14) LookupUsernamesByUbiAccountIDs

Request

Type Name
List<String> UbiAccountIds

Response

Type Name
Map<String, String> Usernames

(15) LookupUbiAccountIDsByUsernameSubString

Request

Type Name
String UsernameSubString

Response

Type Name
Map<String, String> UbiAccountIDs

(16) UserHasPlayed

Request

Type Name
List<String> UbiAccountIDs

Response

Type Name
Map<String, Bool> UserPresence

(17) IsUserPlaying

Request

Type Name
List<String> UbiAccountIDs

Response

Type Name
Map<String, Bool> UserPresence

(18) LookupUbiAccountIDsByUsernamesGlobal

Request

Type Name
List<String> Usernames

Response

Type Name
Map<String, String> UbiAccountIDs

(19) LookupUbiAccountIDsByEmailsGlobal

Request

Type Name
List<String> Emails

Response

Type Name
Map<String, String> UbiAccountIDs

(20) LookupUsernamesByUbiAccountIDsGlobal

Request

Type Name
List<String> UbiAccountIds

Response

Type Name
Map<String, String> Usernames

(21) GetTOSEx

Request

Type Name
String countryCode
String languageCode
Bool htmlVersion

Response

Type Name
TOSEx tosex

(22) HasAcceptedLatestTOS

Request

This method does not take any parameters.

Response

Type Name
Bool hasAccepted
List<ValidationFailureReason> failedReasons

(23) AcceptLatestTOS

Request

This method does not take any parameters.

Response

Type Name
List<ValidationFailureReason> failedReasons

Types

UbiAccount (Structure)

Type Name
String m_ubiAccountId
String m_username
String m_password
UbiAccountStatus m_status
String m_email
DateTime m_dateOfBirth
Uint32 m_gender
String m_countryCode
Bool m_optIn
Bool m_thirdPartyOptIn
String m_firstName
String m_lastName
String m_preferredLanguage
List<ExternalAccount> m_externalAccounts

TOS (Structure)

Type Name
String m_localeCode
String m_content
String m_storingInfoQuestion

TOSEx (Structure)

Type Name
String m_localeCode
List<String> m_contents
String m_storingInfoQuestion

ValidationFailureReason (Structure)

Type Name
Uint32 m_validationId
String m_description

UsernameValidation (Structure)

Type Name
List<String> m_suggestions
List<ValidationFailureReason> m_reasons

Country (Structure)

Type Name
String m_code
String m_name

ExternalAccount (Structure)

Type Name
Uint32 m_accountType
String m_id
String m_username

UbiAccountStatus (Structure)

Type Name
Uint32 m_basicStatus
Bool m_missingRequiredInformations
Bool m_recoveringPassword
Bool m_pendingDeactivation
Clone this wiki locally