Skip to main content

/Command/IsValidGroup

Tests if the group specified is equivalent to the union of the natural groups of its members; returns 1 if true.

Request Method

POST

URL Parameters

None. Note that a request body is required; see the next heading.

Request Body Details

This endpoint uses the following property of the request body:

group

Required. The name of the cube group to test.

Example Request

Example Response

{
    "isValid": 1,
    "group": "{\"Cubes\":[{\"CubeKey\":\"EXPRESSIONHOLEFOODS\",\"CubeDisplayName\":\"HoleFoods Base\",\"NaturalGroup\":\"2\",\"CustomBuildOrder\":1,\"NaturalBuildOrder\":1,\"LastModDate\":\"65499,67761.888342\",\"UpdatePlan\":\"BuildSynch\",\"Disabled\":\"true\",\"BuildFrequency\":1,\"BuildTimeUnit\":\"Week\",\"BuildDayOfWeek\":\"1\",\"BuildDayOfMonth\":1,\"SynchFrequency\":1,\"SynchTimeUnit\":\"Day\",\"DSTimeEnabled\":\"true\",\"BuildAsynch\":\"true\",\"IndependentSync\":\"false\"}],\"GroupName\":\"Group 2\",\"IsRegistered\":\"true\",\"IsValid\":\"true\",\"UpdatePlan\":\"BuildSynch\",\"Disabled\":\"true\",\"BuildFrequency\":1,\"BuildTimeUnit\":\"Week\",\"BuildDayOfWeek\":\"1\",\"BuildDayOfMonth\":1,\"SynchFrequency\":1,\"SynchTimeUnit\":\"Day\",\"BuildAsynch\":\"true\"}",
    "groups": {
        "1": [
            {
                "DEPENDSONHOLEFOODS": [
                    1
                ]
            }
        ],
        "2": [
            {
                "EXPRESSIONHOLEFOODS": [
                    1
                ]
            }
        ],
        "3": [
            {
                "HOLEFOODS": [
                    1
                ]
            }
        ],
        "4": [
            {
                "JMD1340": [
                    1
                ]
            }
        ],
        "5": [
            {
                "MYCUBE89212": [
                    1
                ]
            }
        ],
        "6": [
            {
                "NEWHOLEFOODS": [
                    1
                ]
            }
        ],
        "7": [
            {
                "PATIENTS": [
                    1
                ]
            }
        ],
        "8": [
            {
                "PREBUILTHOLEFOODS": [
                    1
                ]
            }
        ],
        "9": [
            {
                "FILTERRDOCTORS": [
                    2
                ],
                "FILTERRPATIENTS": [
                    5
                ],
                "RCITIES": [
                    1
                ],
                "RCITYRAINFALL": [
                    3
                ],
                "RDOCTORS": [
                    4
                ],
                "RPATIENTS": [
                    6
                ],
                "RPATIENTSDEPENDSON": [
                    7
                ],
                "RPATIENTSINHERIT": [
                    8
                ]
            }
        ]
            },
            "cubes": {
        "DEPENDSONHOLEFOODS": [
            1
        ],
        "EXPRESSIONHOLEFOODS": [
            2
        ],
        "FILTERRDOCTORS": [
            9,
            {
                "dependents": [
                    2,
                    {
                "FILTERRPATIENTS": [],
                "RPATIENTS": []
                    }
                ]
            }
        ],
        "FILTERRPATIENTS": [
            9
        ],
        "HOLEFOODS": [
            3
        ],
        "JMD1340": [
            4
        ],
        "MYCUBE89212": [
            5
        ],
        "NEWHOLEFOODS": [
            6
        ],
        "PATIENTS": [
            7
        ],
        "PREBUILTHOLEFOODS": [
            8
        ],
        "RCITIES": [
            9,
            {
                "dependents": [
                    7,
                    {
                "FILTERRDOCTORS": [],
                "FILTERRPATIENTS": [],
                "RCITYRAINFALL": [],
                "RDOCTORS": [],
                "RPATIENTS": [],
                "RPATIENTSDEPENDSON": [],
                "RPATIENTSINHERIT": []
                    }
                ]
            }
        ],
        "RCITYRAINFALL": [
            9
        ],
        "RDOCTORS": [
            9,
            {
                "dependents": [
                    3,
                    {
                "RPATIENTS": [],
                "RPATIENTSDEPENDSON": [],
                "RPATIENTSINHERIT": []
                    }
                ]
            }
        ],
        "RPATIENTS": [
            9
        ],
        "RPATIENTSDEPENDSON": [
            9
        ],
        "RPATIENTSINHERIT": [
            9
        ]
            },
            "buildOrders": {
        "1": [
            1,
            {
                "1": [
                    "DEPENDSONHOLEFOODS"
                ]
            }
        ],
        "2": [
            1,
            {
                "1": [
                "EXPRESSIONHOLEFOODS"
                ]
            }
        ],
        "3": [
            1,
            {
                "1": [
                "HOLEFOODS"
                ]
            }
        ],
        "4": [
            1,
            {
                "1": [
                "JMD1340"
                ]
            }
        ],
        "5": [
            1,
            {
                "1": [
                "MYCUBE89212"
                ]
            }
        ],
        "6": [
            1,
            {
                "1": [
                "NEWHOLEFOODS"
                ]
            }
        ],
        "7": [
            1,
            {
                "1": [
                "PATIENTS"
                ]
            }
        ],
        "8": [
            1,
                {
                "1": [
                "PREBUILTHOLEFOODS"
                ]
            }
        ],
        "9": [
            8,
            {
                "1": [
                    "RCITIES"
                ],
                "2": [
                    "FILTERRDOCTORS"
                ],
                "3": [
                    "RCITYRAINFALL"
                ],
                "4": [
                    "RDOCTORS"
                ],
                "5": [
                    "FILTERRPATIENTS"
                ],
                "6": [
                    "RPATIENTS"
                ],
                "7": [
                    "RPATIENTSDEPENDSON"
                ],
                "8": [
                    "RPATIENTSINHERIT"
                ]
            }
        ]
    },
    "Error": "",
    "status": 1
}

For information that applies to all response objects, see Notes on the Response Objects.

FeedbackOpens in a new tab