getFieldMetaData
This function retrieved the metadata related to the fields and their fixed values.
Input
|
Class |
Name |
Type |
Required |
Details |
|
GetFieldMetaDataRequest |
userId |
String |
Yes |
The callers user name |
|
GetFieldMetaDataRequest |
Password |
String |
Yes |
The callers password |
|
GetFieldMetaDataRequest |
fieldIds |
String[] |
No |
The array of field id’s the meta data is requested for. |
|
GetFieldMetaDataRequest |
getAllFields |
boolean |
No |
An overriding flag to return all the possible fields. |
Output
|
Class |
Name |
Type |
Required |
Details |
|
GetFieldMetaDataResponse |
Success |
boolean |
Yes |
True is succeeded False if failed |
|
GetFieldMetaDataResponse |
returnCode |
String |
No |
See Appendix for details |
|
GetFieldMetaDataResponse |
returnMessage |
String |
No |
Human readable message |
|
GetFieldMetaDataResponse |
FieldMetaData |
String |
Yes |
The report in XML format |
Example
public static void getFieldMetaData(EVSystemServiceStub stub) {
try {
GetFieldMetaDataDocument reqEnvelope =
GetFieldMetaDataDocument.Factory.newInstance();
GetFieldMetaDataRequest request =
reqEnvelope.addNewGetFieldMetaData().addNewRequest();
request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
request.setGetAllFields(true);
GetFieldMetaDataResponseDocument resEnvelope = stub.getFieldMetaData(reqEnvelope);
GetFieldMetaDataResponse response =
resEnvelope.getGetFieldMetaDataResponse().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();
}
}