This action provides a list of all the fields available to the user. Note that all of ExtraView’s security is in force and the calling user will only see the fields to which he has access. Also note that there is no difference in the way that User Defined Fields (UDF’s) are shown compared to ExtraView’s built-in fields. These UDF’s are handled in a seamless way within the API.
Input
Class |
Name |
Type |
Required |
Details |
GetFieldsRequest |
userId |
String |
Yes |
The callers user name |
GetFieldsRequest |
password |
String |
Yes |
The callers password |
Output
Class |
Name |
Type |
Required |
Details |
GetFieldsResponse |
success |
boolean |
Yes |
True is succeeded False if failed |
GetFieldsResponse |
returnCode |
String |
No |
See Appendix for details |
GetFieldsResponse |
returnMessage |
String |
No |
Human readable message |
GetFieldsResponse |
fields |
Array[] |
No |
A list of Field objects |
Field |
id |
String |
Yes |
|
Field |
name |
String |
No |
|
Field |
value |
String |
No |
|
Field |
childOfFieldId |
String |
No |
|
Field |
repeatingRowField |
boolean |
No |
|
Field |
textAreaField |
boolean |
No |
|
Field |
typeOfUserField |
boolean |
No |
|
Example
public static void testGetFields(EVSystemServiceStub stub) {
try {
GetFieldsDocument reqEnvelope = GetFieldsDocument.Factory.newInstance();
GetFieldsRequest request = reqEnvelope.addNewGetFields().addNewParam0();
request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
GetFieldsResponseDocument resEnvelope = stub.getFields(reqEnvelope);
GetFieldsResponse response = resEnvelope.getGetFieldsResponse().getReturn();
if (response.getSuccess()) {
System.out.println("success: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
} else {
System.out.println("failure: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
}
} catch (Exception e) {
e.printStackTrace();
System.err.println("nnn");
}
}