getItemFieldList

This action provides a list of all the available fields to the user. Note that all of ExtraView’s security is in force and an individual 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 than other fields. UDF’s are handled in a seamless way within the API.

Input

Class

Name

Type

Required

Details

GetItemFieldListRequest

userId

String

Yes

The callers user name

GetItemFieldListRequest

password

String

Yes

The callers password

Output

Class

Name

Type

Required

Details

GetItemFieldListResponse

success

boolean

Yes

True is succeeded False if failed

GetItemFieldListResponse

returnCode

String

No

See Appendix for details

GetItemFieldListResponse

returnMessage

String

No

Human readable message

GetItemFieldListResponse

fields

Array

No

A list of FieldBeans

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 testGetItemFieldList(EVItemServiceStub stub) {
    try {
        GetItemFieldListDocument reqEnvelope = GetItemFieldListDocument.Factory.newInstance();
        GetItemFieldListRequest request =
            reqEnvelope.addNewGetItemFieldList().addNewParam0();
        request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
        request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
        GetItemFieldListResponseDocument resEnvelope = stub.getItemFieldList(reqEnvelope);
        GetItemFieldListServiceResponse response =
            resEnvelope.getGetItemFieldListResponse().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");
    }
}