getFieldList

This action provides a list of all the available fields to the user who calls the function.

Input

Class

Name

Type

Required

Details

GetFieldListRequest

userId

String

Yes

The callers user name

GetFieldListRequest

password

String

Yes

The callers password

Output

Class

Name

Type

Required

Details

GetFieldListResponse

success

boolean

Yes

True is succeeded False if failed

GetFieldListResponse

returnCode

String

No

See Appendix for details

GetFieldListResponse

returnMessage

String

No

Human readable message

GetFieldListResponse

fields

Array

No

A list of Field objects

Field

id

String

Yes

 

Field

name

String

Yes

 

Field

value

String

No

 

Field

childOfFieldId

String

No

 

Field

repeatingRowField

boolean

No

 

Field

textAreaField

boolean

No

 

Field

typeOfUserField

boolean

No

 

Example

public static void testGetFieldList(EVReportServiceStub stub) {
    try {
        GetFieldListDocument reqEnvelope = GetFieldListDocument.Factory.newInstance();
        GetFieldListRequest request = reqEnvelope.addNewGetFieldList().addNewParam0();
        request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
        request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
        GetFieldListResponseDocument resEnvelope = stub.getFieldList(reqEnvelope);
        GetFieldListResponse response = resEnvelope.getGetFieldListResponse().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");
    }
}