Posted by Angham Al-Banawien, Last modified by Diab Mansour on 19 July 2021 09:40 PM


Function GetClientByID (ClientID As long) As String


The GetClientByID operation is used to get client information for a given client number.

Request Parameters

Name Description  Required



  • Client number to get its information 
  • Type: long
  • Default: None
  • Constraints: Must be valid client ID and accessible by logged in dealer



Response Elements

Name Description 

The operation returns JSON object of type ClientInformation, otherwise an explicit  error code is returned if ClientID is less than 0. 

The Following are the client Information data member    

  •    ClientID : Client idintifier.
  •    ParentID : parent idintifier which the client is belong to
  •    UserName : client username
  •    FirstName : client first name
  •    SecondName : client second name.
  •    ThirdName : client third name
  •    lastName : client last name
  •    Phone : client phone number
  •    Email : client Email
  •    Address : client Address
  •    Country : client Country
  •    Mobile : client Mobile
  •    TelFax : client TelFax
  •    Pop : Client pop
  •    Fax : client Fax
  •    Demo : Boolean value that indicate if client is demo or not
  •    Read_Only : Boolean value that indicate if client is read only or not
  •    ClientType (1 = client type , 2 = Office Type, 3 Group Type)
  •    ForceChangePW : Detect if the client will be force change password after the first login



See Also

VertexFX Backoffice WCF Service Index

(0 vote(s))
Not helpful

Comments (0)
Post a new comment
Full Name:
CAPTCHA Verification 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions