There are two types of objects. One is a request objects and the
other is a response objects. These objects include:
-
Request objects
-
Response objects
UserInfo
|
Store the user profile information.
|
Properties
|
|
String
|
account
|
User's account name. The account is exclusive in WebExronos
system.
|
|
String
|
password
|
Password of this account. It's used for login.
|
|
String
|
corpName
|
The corporation name of this user. It is not required.
|
|
String
|
appName
|
The name of the application that uses this service. It is not
required.
|
|
String
|
email
|
The email address used for contact.
|
|
String
|
contactPerson
|
The contact person. It is not required.
|
|
String
|
phone
|
The phone number used for contact. It is not required.
|
|
String
|
fax
|
The fax number. It is not required.
|
|
int
|
status
|
The status of this user. Include
-
-2: Rejected
-
-1: Under review by administrator
-
0: Disabled
-
1: Active
|
|
boolean
|
admin
|
Used to identify whether this user is the administrator or not.
|
TimeSchedule
|
This object stores the time definition information. The
definition can use the format like the "cron"
expression in UNIX or just a simple type. The simple type only
requires to indicate the repeat interval and repeat count.
|
Properties
|
|
String
|
cronExpression
|
The "cron" style expression. If this property is not
empty, the
repeatCount and
repeatInterval property will be omitted. When user uses
this property to create a trigger, the server will create a
trigger that uses this cron expression.
|
|
int
|
repeatCount
|
The maximum repeat times that will the job will be activated. 0
means unlimited times. This property will be adopted only when
the
cronExpression field is empty.
|
|
long
|
repeatInterval
|
The time interval before the server will call back. The unit of
this property is the millisecond. This property will be adopted
only when
cronExpression is empty.
|
|
long
|
startTime
|
When to start this trigger. If this value is 0, start time is
immediately. If this field is filled, the real call back time
will not only belong to this property but also to
timeZone property.
|
|
long
|
endTime
|
Defines the time when the job is ended and whether the
repeatCount value is reached. If this value is 0, there is no
end for the job.
|
|
String
|
timeZone
|
The time zone used for the
startTime and
endTime. The default time zone is "GMT+0".
This property also influences the
cronExpression property.
|
LoginInfo
|
Stores the login information used to
login.
|
Properties
|
|
String
|
account
|
The account to login.
|
|
String
|
password
|
The password to login.
|
KeyPair
Stores the information as key=value.
|
Properties
|
|
String
|
key
|
Key string, cannot be null.
|
|
String
|
value
|
Value string, cannot be null.
|
CallBack
|
Store how the server calls back to the client.
|
Properties
|
|
String
|
callBackType
|
The type of callback. Current only support type
"HTTP".
|
|
KeyPair[]
|
callBackParams
|
The parameters of callback type.The type
"HTTP" only need a parameter -
"urlString".
|
BasicResult
|
Normal operation results. Includes the error information and
operation success indicators.
|
Properties
|
|
boolean
|
opSuccess
|
Indicates whether the operation is successful. If not
successful, the error object contains the error information.
|
|
ErrorInfo
|
error
|
If the operation is not successful, this property will contain
the error information.
|
LoginResult
extends BasicResult
|
Extends from BasicResult. Add additional identity property.
|
Properties
|
|
String
|
identity
|
The identity returned after successful login is used in later
operations.
|
ScheduleResult
extends BasicResult
|
This object is extended from
BasicResult. It's returned by
schedule operation.
|
Properties
|
|
String
|
jobName
|
If this operation is processed successfully by the server, the
job name will be returned.
|
ErrorInfo
|
Stores the error code and information sent by server.
|
Properties
|
|
long
|
errorCode
|
The error code.
|
|
String
|
errorMessage
|
The error description.
|
|
String[]
|
errorLog
|
Detailed error information.
|