You are on page 1of 15

S.

No API Name Url


1 UserSignUp https://www.tranzlationglobal.com/TZGlobalWebAPI/Account/UserSignUp
2 ValidateUserCredentials https://www.tranzlationglobal.com/TZGlobalWebAPI/Account/ValidateUserCredentials
3 UserProfileUpdate https://www.tranzlationglobal.com/TZGlobalWebAPI/Account/UserProfileUpdate
4 UserResetPassword https://www.tranzlationglobal.com/TZGlobalWebAPI/Account/UserResetPassword

S.No API Method Name Parameter


1 UserSignUp email_address

2 UserSignUp password
3 UserSignUp first_name
4 UserSignUp last_name
5 UserSignUp user_name
6 UserSignUp country_id
7 UserSignUp secret_token
8 UserSignUp middle_name

9 UserSignUp dob
10 UserSignUp phonenumber
11 UserSignUp state_id
12 UserSignUp img_path
13 UserSignUp signature_path
14 UserSignUp signature_blob
15 UserSignUp image_blob
16 UserSignUp gender_id
17 UserSignUp session_timeout

S.No API Method Name Field Name

1 UserSignUp SuccessMessage

2 UserSignUp ErrorMessage
3 UserSignUp user_id

In
S.No API Method Name Parameter
1 ValidateUserCredentials email_address

2 ValidateUserCredentials password
3 ValidateUserCredentials secret_token

Ou
S.No API Method Name Field Name
1 ValidateUserCredentials user_id
2 ValidateUserCredentials usertype_id
3 ValidateUserCredentials usertype_name
4 ValidateUserCredentials email_address
5 ValidateUserCredentials user_name
6 ValidateUserCredentials first_name
7 ValidateUserCredentials last_name
8 ValidateUserCredentials phonenumber
9 ValidateUserCredentials dob
10 ValidateUserCredentials ssn
11 ValidateUserCredentials address
12 ValidateUserCredentials address_two
13 ValidateUserCredentials gender_id
14 ValidateUserCredentials gender
15 ValidateUserCredentials country_name_full
16 ValidateUserCredentials state_id
17 ValidateUserCredentials img_path

18 ValidateUserCredentials ErrorMessage

19 ValidateUserCredentials session_timeout

S.No API Method Name Parameter


1 UserProfileUpdate user_id
2 UserProfileUpdate first_name
3 UserProfileUpdate last_name
4 UserProfileUpdate secret_token
5 UserProfileUpdate dob
6 UserProfileUpdate phonenumber
7 UserProfileUpdate ssn
8 UserProfileUpdate updated_by
9 UserProfileUpdate state_id
10 UserProfileUpdate country_id
11 UserProfileUpdate gender_id

12 UserProfileUpdate img_path
13 UserProfileUpdate signature_blob
14 UserProfileUpdate image_blob
15 UserProfileUpdate session_timeout

S.No API Method Name Field Name


1 UserProfileUpdate ErrorMessage

S.No API Method Name Parameter


1 UserResetPassword email_address
2 UserResetPassword password
3 UserResetPassword secret_token

S.No API Method Name Field Name


1 UserResetPassword ErrorMessage
2 UserResetPassword isReset
3 UserResetPassword isMailSentYN
Catalogue of TranslationGlobal
ww.tranzlationglobal.com/TZGlobalWebAPI/Account/UserSignUp
ww.tranzlationglobal.com/TZGlobalWebAPI/Account/ValidateUserCredentials
ww.tranzlationglobal.com/TZGlobalWebAPI/Account/UserProfileUpdate
ww.tranzlationglobal.com/TZGlobalWebAPI/Account/UserResetPassword

Input Specification - UserSignUp


Optionality
Required

Required
Required
Required
Required
Required
Required
Optional

Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

Output Specification - UserSignUp


Comment

It shows success message when email has been sent to the user.

It shows the Error Message when activation link not sent to the user Email.
It gives the created User Id of the user.

Input Specification - ValidateUserCredentials


Optionality
Required

Required
Required

Output Specification - ValidateUserCredentials


Comment
It generates the user_id for the user in a unique manner.
It specifies the type of the user by id
It specifies the type of the user by name.
It shows the email_address which was given in ValidateUserCredentials.
It shows the name of the user from user object.
It shows the firstname of the user from the user object.
It shows the lastname of the user from the user object.
It shows the phonenumber of the user.
It shows the dob of the user.
It shows the ssnumber of the user.
It shows the address of the user.
It shows the second address of the user.
It shows the gender Id of the user.
It shows the gender of the user.
It shows the country name of the user.
It shows the state id of the user.
It shows the image path of the user.

It returns the message when any error message occured.

It returns session_timeout value.

Input Specification - UserProfileUpdate


Optionality
Required
Required
Required
Required
Optional
Optional
Optional
Optional
Optional
Optional
Optional

Optional
Optional
Optional
Optional

Output Specification - UserProfileUpdate


Comment
It shows the message when user profile details updated successfully.

Input Specification - ResetPassword


Optionality
Required
Required
Required

Output Specification - ResetPassword


Comment
It shows message as updated or failed when password reset.
It shows true/false when password updated successfully/failed.
It shows true/false when email send to the user mail successfully/failed.
Catalogue of TranslationGlobal API's

Input Specification - UserSignUp


Datatype
String

String
String
String
String
Int64
String
String

String
String
Int64
String
String
String
String
Int32
Int32

Output Specification - UserSignUp

String

String
Int64

Specification - ValidateUserCredentials
String

String
String

t Specification - ValidateUserCredentials

put Specification - UserProfileUpdate

Int64
String
String
String
String
String
String
Int64
Int32
Int32
Int32

String
String
String
Int32

put Specification - UserProfileUpdate

nput Specification - ResetPassword

String
String
String

utput Specification - ResetPassword


Input Parameter Specification
Click here for Input Specifications
Click here for Input Specifications
Click here for Input Specifications
Click here for Input Specifications

Usage
User EmailAddress

User Password
User FirstName
User LastName
User Name
User CountryID
Application SecretToken
User MiddleName

User DateOfBirth
User PhoneNumber
User StateID
User ImagePath
User SignaturePath
Given user signature in base64 form
Given user image in base64 form
GenderID of the user
session timeout of the user

Sample Value

Account created successfully. Activation


link sent to
the email address. Please verify your
account.

Account created successfully, Failure


sending activation
link to the email address.
1
Usage
User EmailAddress

User Password
Application SecretToken

Sample Value
1453
1
Patient
UserDemo1237@gmail.com
UserDemo
User
Demo
7894561230
2022-02-02T00:00:00
464-65-4545
Pragathi nagar, Hyderabad.
Rajiv nagar, Hyderabad.
1
Male
Afghanistan
2
2023\\1450.jpg

The email and password combination


does not match with our records.

10:00

Usage
Generated User Id
Updated FirstName
Updated LastName
Application SecretToken
Updated DateOfBirth
Updated PhoneNumber
User SSNumber
User Id of the Updated user
Updated StateID
Updated CountryID
GenderID of the user

Updated ImagePath
Given user signature in base64 form
Given user image in base64 form
session timeout of the user

Sample Value
Account details updated successfully.

Usage
User EmailAddress
User Password
Application SecretToken

Sample Value
New password is updated successfully.
TRUE
TRUE
Output Parameter Specification
Click here for Output Specifications
Click here for Output Specifications
Click here for Output Specifications a
Click here for Output Specifications

Detail/Expected Value
Enter a valid email address

Password should contain 8 characters or more.


Must have at least one number, one special character, one lowercase
and one uppercase character.
Enter the first name of the user.
Enter the last nameof the user.
Enter the name of the user.
Enter the country Id.
Enter the applicationtoken in which the user account have to create.
Enter the middle name of the user.

Enter the DOB of the user and the format of the DOB should be in
MM/DD/YYYY.
Enter the valid phone number.
Enter the state Id.
Select image path from your computer.
Enter the user signature.
It stores the base64 string of the given signature path.
It stores the base64 string of the given image path.
Enter the gender Id of the user.
It returns session_timeout value.
Detail/Expected Value
Enter the email address which was given in the signup process.

Enter the password which was given in the signup


process or the updated password in the UserProfileUpdate method.
Token of the application in which the user account was created.

Detail/Expected Value
Enter the generated user Id.
Enter the first name that you want to update.
Enter the last name that you want to update.
Token of the application in which the user account was created.
Enter the DateOfBirth that you want to update.
Enter the valid phone number that you want to update.
Enter the valid SSNumber.
Enter Id of the user whom ever updating the profile.
Enter the state Id of the user.
Enter the country Id of the user.
Enter the gender Id of the user.
Enter the image path that you want to update from the location where
the image is stored in your computer.
It stores the base64 string of the given signature path.
It stores the base64 string of the given image path.
It returns session_timeout value.

Detail/Expected Value
Enter the email address which was given in the signup process.
Enter the new password which you want to reset.
Token of the application in which the user account was created.

You might also like