VertexFX BackOffice WCF Service

CreateOffice

81 views 0 Updated on September 20, 2023 hybrid-solutions

Syntax

 Function CreateOffice(ParentID As Integer, Name As String, Username As String, Password As String, IsDemo As Boolean, ReadOnly As Boolean, Phone As String, Fax As String, Mobile As String, TelPWD As String, POB As String, Email As String, Address As String, ForceChangePassword as boolean) As String

Description

The CreateOffice operation is used to create a new client of type office under a specific given parent name.

Request Parameters

Name Description Required
ParentID
  • Parent ID which the new office will be under it
  • Type: Integer
  • Default: None
  • Constraints: Must be valid parent ID and accessible by logged-in dealer
 Yes
Name
  • Office description.
  • Type: String
  • Default: None
 Yes
Username
  • Office username.
  • Type: String.
  • Default: None
 Yes
Password
  • Office password
  • Type: String.
  • Default: None
 Yes
IsDemo
  • To indicate if the office is a demo or not.
  • Type: String
  • Default: None
 Yes
ReadOnly
  • To indicate if the client will only monitor the trades or not
  • Type: Boolean
  • Default: None
 Yes
Phone
  • office phone number
  • Type: String.
  • Default: None
 Yes
Fax
  • office Fax number
  • Type: String
  • Default: None
 Yes
Mobile
  • office mobile number
  • Type: String
 Yes
TelPWD
  • Office TelPWD number
  • Type: String
  • Default: None
 Yes
POB
  • Post office box
  • Type: String
  • Default: None
 Yes
Email
  • office Email address
  • Type: String
  • Default: None
 Yes
Address
  • office Address
  • Type: String
  • Default: None
  

Yes
ForceChangePassword
  • To indicate if the office will have to change the password after the first login or not
  • Type: boolean
 yes


Response Elements

Name Description
Result The operation returns a new office identifier in case of success, otherwise, an explicit error code is returned

 

See Also


VertexFX BackOffice WCF Service Index

Was this helpful?