Represents a Mercury Command 1141 (Extended User Command Configuration) record associated with a controller. A star command maps a keypad entry (*code#) to a procedure execution on the Mercury controller.
Overview of HgStarCommandInfo goes here.
Item -> BaseInfo -> HgStarCommandInfo
| Field | Type | Inherited from | Description |
|---|---|---|---|
| Href | String | Item | Gets or sets the href. |
| CommonName | String | BaseInfo | Common Name of the resource.The common name of the resource. |
| ConcurrencyVersion | Nullable<Int64> | BaseInfo | Gets or Set the Version. |
| InFolderHref | String | BaseInfo | relative path Href value for the containing folderAll objects exist within a folder. Even folders! |
| InFolderKey | String | BaseInfo | Represents the internal ID of the containing folder |
| IsGlobal | Boolean | BaseInfo | If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects. |
| IsReadOnly | Boolean | BaseInfo | Gets or sets a value indicating whether this resource is read-only.Possible Values (true, false) |
| Key | String | BaseInfo | Represents the internal ID of the object. |
| Links | List<Link> | BaseInfo | List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required. |
| Metadata | MetadataItem[] | BaseInfo | The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data. |
| Monikers | MonikerItem[] | BaseInfo | the set of Monikers for this object |
| Notes | NoteInfo[] | BaseInfo | The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted. |
| ObjectLinks | ObjectLinkItem[] | BaseInfo | The set of resources that are related to this resource. Frequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set. |
| Tags | String[] | BaseInfo | the set of tags for this object. Tags are used to group objects together for the purposes of selection and assignment of operation rights. |
| AccessDelay | Int32 | HgStarCommandInfo | Gets or sets the access delay in seconds. Mercury reuses the last valid access at the ACR if it was within this many seconds. Valid range: 0–65534. Values outside this range default to 30 at send time. Maps to SDK field: nAccessDelay. |
| AccessLevelIndex | Int32 | HgStarCommandInfo | Gets or sets the access level index on the controller. Maps to SDK field: nAccLevel. Use -1 to skip access level check. Defaults to -1 (skip check). |
| AcrList | String | HgStarCommandInfo | Gets or sets the ACR list — 64-character positional string of ‘0’/‘1’/‘2’. Position i corresponds to reader port i. ‘1’ = accept, ‘0’ = reject, ‘2’ = no change. Maps to SDK field: cAcrList[65]. |
| Args | Int32[] | HgStarCommandInfo | Gets or sets the nArgs block [nArgs0, nArgs1, nArgs2, nArgs3]. For UCMND_DIRECT: [0]=base procedure, [1]=ACR multiplier, [2]=low limit, [3]=high limit. |
| AuthorityFlag | UserCommandAuthorityFlags | HgStarCommandInfo | Gets or sets the authority flags controlling the access rights check. Maps to SDK field: nAuthorityFlag. Combine flags as needed; use the default (no flags) for keypad-only commands that require no cardholder authority check. |
| CmndCode | String | HgStarCommandInfo | Gets or sets the command string prefix used to match keypad entries (max 6 chars, e.g. “10” matches *102#–*106#). Maps to SDK field: cCmndCode[7]. |
| CommandCode | Int32 | HgStarCommandInfo | Gets or sets the command code (integer representation of the star command, e.g. 101 for *101#). Maps to SDK field: cCmndCode (as integer). |
| CommandType | StarCommandType | HgStarCommandInfo | Gets or sets the Mercury user command type (nUCmndId). Only ExtendedDoorTime (1001) and DirectProcedure (1002) are supported. Defaults to DirectProcedure. |
| HgProcedureItems | List<HgProcedureInfo> | HgStarCommandInfo | List of procedures linked to this star command, one entry per step.Not persisted on the star command document — procedures are stored as separate linkedrecords. The server-side domain model marks the equivalent propertyto enforce this; this DTO is never written to MongoDB directly. |
| IdMode | Int32 | HgStarCommandInfo | Gets or sets the ID mode. SDK: 1=locked (disabled), 2=unlocked (no ID required at keypad), 5-8=controlled access modes. Use 2 (unlocked) — Mercury checks authority via nAccessDelay rather than requiring a card swipe at the keypad. Maps to SDK field: nIdMode. |
| ManagerIndex | Int32 | HgStarCommandInfo | Gets or sets the manager index component (0–255). nUsrLevel sent to Mercury = (ManagerIndex × 256) + ManagerLevel. Use 0 to skip. |
| ManagerLevel | Int32 | HgStarCommandInfo | Gets or sets the manager level component (0–255). nUsrLevel sent to Mercury = (ManagerIndex × 256) + ManagerLevel. Use 0 to skip. |
| ProcedureIndex | Int32 | HgStarCommandInfo | Gets or sets the procedure index on the Mercury controller (controllerIndex on HgProcedure). Maps to SDK field: nArgs[0] — base procedure number. |
{
"Href" : "String",
"CommonName" : "String",
"ConcurrencyVersion" : "Nullable\<Int64\>",
"InFolderHref" : "String",
"InFolderKey" : "String",
"IsGlobal" : "Boolean",
"IsReadOnly" : "Boolean",
"Key" : "String",
"Links" : "List\<[Link](/object-model/link)\>",
"Metadata" : "[MetadataItem](/object-model/metadataitem)[]",
"Monikers" : "[MonikerItem](/object-model/monikeritem)[]",
"Notes" : "[NoteInfo](/object-model/noteinfo)[]",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"Tags" : "String[]",
"AccessDelay" : "Int32",
"AccessLevelIndex" : "Int32",
"AcrList" : "String",
"Args" : "Int32[]",
"AuthorityFlag" : "[UserCommandAuthorityFlags](/object-model/usercommandauthorityflags)",
"CmndCode" : "String",
"CommandCode" : "Int32",
"CommandType" : "[StarCommandType](/object-model/starcommandtype)",
"HgProcedureItems" : "List\<[HgProcedureInfo](/object-model/hgprocedureinfo)\>",
"IdMode" : "Int32",
"ManagerIndex" : "Int32",
"ManagerLevel" : "Int32",
"ProcedureIndex" : "Int32"
}