TITLE | VALUE | |
---|---|---|
NAME | HMP GET RELATED ORDERS | |
DESCRIPTION | Returns the parent, children, and/or siblings (orders that share the same parent) of an order from the ORDER (#100) FILE in JSON format. | |
TAG | RELATED | |
ROUTINE | HMPORRPC | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | ORDER IEN | |
DESCRIPTION | IEN to the ORDER (#100) file, indicates which order from which to draw related orders. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | Returns a JSON message containing an IEN for "parent," a list of IENS for "children," and/or a list of IENs for "siblings", depending on which fields are applicable to an order (i.e., an order with no parent will not have a "parent" value). If an error is returned, it will be in the "error" field. { |TAB|"parent": 7282.1, |TAB|"siblings": [7283.1, 7284.1, 7285.1, 7286.1, 7287.1, 7288.1, 7289.1, 72 |TAB||TAB|90.1, 7291.1, 7292.1, 7293.1, 7294.1, 7295.1, 7296.1, 7297.1, 7298.1, 7299.1, 7300.1, 7301. |TAB||TAB|1, 7302.1, 7303.1, 7304.1, 7305.1, 7306.1, 7307.1 |TAB|] } or { |TAB|"children": [ |TAB| 7283.1, 7284.1, 7285.1, 7286.1, 7287.1, 7288.1, 7289.1, 7290.1, 7291.1, 7292.1, 7293.1, 7294.1, 7295.1, 7296.1, 7297.1, |TAB| 7298.1, 7299.1, 7300.1, 7301.1, 7302.1, 7303.1, 7304.1, 7305.1, 7306.1, 7307.1 |TAB|] } or { |TAB|"error": "order not found" } | |
AVAILABILITY | ||
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED |