GET Request Parameters

Table 1.
Parameter Name	Required	Description
requestName	Yes	A unique Request Name specified for the Gateway Request.
requestGuid	Yes	A globally unique id (GUID) for the request. For information on how to generate a GUID refer to: http://betterexplained.com/articles/the-quick-guide-to-guids/ For information on creating GUIDs in Java refer to: http://www.javapractices.com/topic/TopicAction.do?Id=56
maxResults	Yes	A non-negative integer between 1 and 100 that indicates the maximum number of results for this request.
firstResult	No	A non-negative integer that indicates the first result. Defaults to 0. This is used for paging large result sets.
orderByField	No	The field name by which the results are ordered. Defaults to unspecified.
asc	No	Ascending or descending order. Specify true or false. Defaults to true.
format	No	A flat or hierarchical to indicate the desired JSON format in the results field. Defaults to flat.
filters	No	A uniqueId of a known record, a string field name, EQUAL_TO and a string value or a date field name, comparison operator and a date to filter the results. Operators: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO Examples: filters=[['startDate','GREATER_THAN','07/01/2013'], ['startDate','LESS_THAN','12/31/2015']] filters= [['uniqueId','EQUAL_TO',' 8bd88078-ea60-438e-8022-34b79ce26f08']]

requestName

Yes

A unique Request Name specified for the Gateway Request.

requestGuid

Yes

A globally unique id (GUID) for the request. For information on how to generate a GUID refer to: http://betterexplained.com/articles/the-quick-guide-to-guids/ For information on creating GUIDs in Java refer to: http://www.javapractices.com/topic/TopicAction.do?Id=56

maxResults

Yes

A non-negative integer between 1 and 100 that indicates the maximum number of results for this request.

firstResult

No

A non-negative integer that indicates the first result. Defaults to 0. This is used for paging large result sets.

orderByField

No

The field name by which the results are ordered. Defaults to unspecified.

asc

No

Ascending or descending order. Specify true or false. Defaults to true.

format

No

A flat or hierarchical to indicate the desired JSON format in the results field. Defaults to flat.

filters

No

A uniqueId of a known record, a string field name, EQUAL_TO and a string value or a date field name, comparison operator and a date to filter the results.

Operators: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO

Examples: filters=[['startDate','GREATER_THAN','07/01/2013'], ['startDate','LESS_THAN','12/31/2015']]

filters= [['uniqueId','EQUAL_TO',' 8bd88078-ea60-438e-8022-34b79ce26f08']]