| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Unique identifier provided by the User to distinguish this ProgramGroup from others. This is used to create links to this ProgramGroup and it must be unique across the entire Program |
integer |
None. |
| IDType |
The Type of ID provided. This is used to determine if the ID field is for an existing ProgramGroup or for a new ProgramGroup |
IDType |
None. |
| Name |
Optional name of the ProgramGroup |
string |
None. |
| Description |
Optional description of the ProgramGroup |
string |
None. |
| ParentGroupID |
Unique identifier for a ProgramGroup that is the Parent of this one, if applicable |
integer |
None. |
| DisplayIndex |
Index used for displaying the ProgramGroup, used for displaying them in a specific order |
integer |
None. |
| ParentGroupIDType |
The Type of ParentGroupID provided. Is it an existing ID or a new ID? |
IDType |
None. |
| Offset |
Offset to use for this ProgramGroup to determine the timing of it |
time interval |
None. |
| LinkID |
The unique ID of the item that this ProgramGroup is linked to, if applicable. It can be linked to either a ProgramGroup or a ProgramStep, as defined by LinkObjectType. This must correspond to the other item's ID field |
integer |
None. |
| LinkIDType |
The Type of LinkID provided. Is it an existing ID or a new ID? |
IDType |
None. |
| LinkObjectType |
Defines the type of item this ProgramGroup is linked to via LinkID |
LinkObjectType |
None. |
| LinkType |
Defines how this ProgramGroup is linked to the item specified by LinkID |
LinkType |
None. |
| ProgramSteps |
The ProgramSteps of the Program to handle. This contains information for Adding and/or Updating ProgramSteps. |
Collection of Update_ProgramStep |
None. |