/rpg/request/index.htmlChapter 6.1 RPG Request Procedures This chapter describes procedures used to read incoming request string.Hugoen-usMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqexist/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqexist/index.htmlThis procedure checks if given object exists. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” The procedure returns *ON if object exists or *OFF if object do not exist. Usually procedure reqExist is used in “if” statement./rpg/request/reqfieldexist/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqfieldexist/index.htmlThis procedure checks if given field exists in request “control:fields” section. There is special section in request. Caller can use this section to subset returned data. This procedure is mostly used internally in API framework and there is no needs to use it from RPG manager program. Parameter Type Description fieldName 1024A VARYING, VARSIZE Mandatory Name of field which is searched in request “control”{“fields”:[…] table Function reqFieldExist checks if given field exists in section “control:fields”. If so, it returns *ON. If not exists then return *OFF. If there is no section control, then procedure always returns *ON./rpg/request/reqget3statevalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqget3statevalue/index.htmlThis procedure retrieves 3-State value for given node string. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” patern 10i 0 VARSIZE Optional Conversion pattern (see patterns) valueType 1A Optional Returns type of value (see types of value) exists N Optional Returns *ON if value exists, *OFF if value does not exit Procedure returns character vale depend on pattern (see patterns). In case of error the returned value is ‘ERROR’/rpg/request/reqgetblobvalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetblobvalue/index.htmlThis procedure retrieves Blob value for given node string. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” valueLength 10U 0 Optional Returns length of Value in bytes valueType 1A Optional Returns type of value (see types of value) exists N Optional Returns *ON if value exists, *OFF if value does not exit The procedure returns poiner to Blob value in memory./rpg/request/reqgetbooleanvalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetbooleanvalue/index.htmlThis procedure retrieves Boolean value for given object. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” patern 10i 0 VARSIZE Optional Conversion pattern (see patterns) valueType 1A Optional Returns type of value (see types of value) exists N Optional Returns *ON if value exists, *OFF if value does not exit Procedure returns character value depend on pattern (see patterns)/rpg/request/reqgetdatevalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetdatevalue/index.htmlThis procedure retrieves date value for given node string. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” valueType 1A Optional Returns type of value (see types of value) exists N Optional Returns *ON if value exists, *OFF if value does not exit The procedure converts character value date *iso format and returns numeric 8P 0 (YYYYMMDD):/rpg/request/reqgetfirstchildnode/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetfirstchildnode/index.htmlThis procedure gets first child node if exist. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” exists N Optional Returns *ON if child node exists, *OFF if child node does not exit The procedure returns first child node name (1024A). If the child node does not exist then procedure returns *BLANKS./rpg/request/reqgetnextchildnode/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetnextchildnode/index.htmlThis procedure gets next child node if exist. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” exists N Optional Returns *ON if child node exists, *OFF if child node does not exit The procedure returns next child node name (1024A). If the child node does not exist then procedure returns *BLANKS./rpg/request/reqgetnumofelements/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetnumofelements/index.htmlThis procedure retrieves number of array elements for given node. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” NOTE: The last node name must be fllowed by “[]” The procedure returns number of elements for array (30P 0)./rpg/request/reqgettimevalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgettimevalue/index.htmlThis procedure retrieves Time value for given node string. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” valueType 1A Optional Returns type of value (see types of value) exists N Optional Returns *ON if value exists, *OFF if value does not exit The procedure converts character value time *iso format and returns numeric 6P 0 (HHMMSS):/rpg/request/reqgetucs2value/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetucs2value/index.htmlThis procedure returns parameter value as UCS2 string. Parameter Type Description baseNode 1024C VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024C VARYING, VARSIZE Optional, can be omited Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” valueType 1A Optional, can be omited Returns type of value (see types of value) exists N Optional, can be omited Returns *ON if value exists, *OFF if value does not exit valuePtr POINTER Optional, can be omited Returns pointer in memory where value resides valueLength 10U 0 Optional, can be omited Returns length of value in bytes unescape N Optional *ON or *OFF (Default = *ON) Indicates if value must be “unescaped” means removed ‘' escape character NOTE : The node strings are UCS2. The result value is also UCS2. The procedure returns value as UCS2 string even if the value is numeric (1024C). It is up to programmer to convert string to numeric later./rpg/request/reqgetvalue/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetvalue/index.htmlThis procedure returns parameter value as string. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional, can be omited Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” valueType 1A Optional, can be omited Returns type of value (see types of value) exists N Optional, can be omited Returns *ON if value exists, *OFF if value does not exit valuePtr POINTER Optional, can be omited Returns pointer in memory where value resides valueLength 10U 0 Optional, can be omited Returns length of value in bytes unescape N Optional *ON or *OFF (Default = *ON) Indicates if value must be “unescaped” means removed ‘' escape character The procedure returns value as string even if the value is numeric (1024A). It is up to programmer to convert string to numeric later./rpg/request/reqgetvaluetype/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/request/reqgetvaluetype/index.htmlThis procedure returns parameter value type. Parameter Type Description baseNode 1024A VARYING, VARSIZE Mandatory This parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id” node 1024A VARYING, VARSIZE Optional Node name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:” The procedure returns value type (1A). See table bellow. Types of value: