ip1FieldValues.get

Description

ip1FieldValues.get lists field values and description up to the specified number of records. 

Input/Output parameters

Note:   This API is using group field “fieldGroupName “ as an input. Grouped fields are different database fields that are grouped under one ID e.g. IBR & WH as BRWH. All the generic field APIs must use the field group names, even if a field is a single field.  Please refer to Fields.xlsx for details of when to use Field name or Field group names in IP1 APIs.

JSON example

View JSON request and response examples

Request:

{
“IptorAPI”: “1.0”,
“method”: “ip1FieldValues.get”,
“params”: {
“fieldGroupName”: “warehouse”,
“lastRecord”: “0001”,
“noOfRecords”: 3
},
“id”: “1234567890”
}

Response:

{
“IptorAPI”: “1.0”,
“data”: {
“lists”: [
{
“fieldValue”: “0005”,
“fieldDescription”: “LOAN STOCK”
},
{
“fieldValue”: “0009”,
“fieldDescription”: “SERVICE TEST”
},
{
“fieldValue”: “0020”,
“fieldDescription”: “PENRITH SATELLITE”
}
],
“lastRecord”: “0020”,
“”: 3,
“moreRecord”: “Y”,
“status”: “”
},
“id”: “1234567890”
}

Response format

For standard response format for IP1 API methods, see Response format.

Related topics

ip1FieldValue.validate

ip1FieldAttributes.get