Cisco Physical Access Control API Reference Guide, Release 1.5.0
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- January 8, 2014
Chapter: Index
Index
A
ackAlarm 134
addExceptionToSchedule 15
Additional Information 183
Precursor to APIs based on Location
Sample Usecases 183
API
authentication 113
function
list, See function
overview 16
summary 11
license 19
service 18
appliance serial number 112
applyConfigurationChanges 16
applyConfigurationChangesToLocation 16
applyScheduleToDoor 13
assignAccessLevels 149
authenticateUser 17
Authentication and Authorization 113
C
clearAlarm 132
Configuration changes
applyConfigurationChanges
applyConfigurationChangesToLocation 16
createSchedule 15
createTimeEntry 14
createTimeEntryCollection 15
createTimeRangeGroup 15
D
deleteSchedule 15
deleteTimeEntry 14
deleteTimeEntryCollection 15
deleteTimeRangeGroup 15
E
enrollBadge 147
enrollPerson 118
Event Definition Format 186
Event Notification 136
External events 185
F
fault codes 31
G
getAccessEventsByDoor 126
getAccessLevelByName 145
getAccessLevelByPerson 153
getAccessLevelByUnid 157
getAcDeviceTypes 18
getAlarmDuplicates 135
getAlarmInstructions 12
getAllAccessLevelNames 145
getAllAccessLevels 144
getAllAcDevices 112
getAllAlarmsByCategory 128
getAllAlarmsByType 129
getAllAlarmUpdates 130
getAllBadgeRefs 158
getAllBadgesByPerson 150
getAllBadgeTemplateNames 152
getAllBadgeTypeIds 158
getAllCameraDevices 110
getAllDepartments 122
getAllDoorGroups 115
getAllDoorsByGroup 115
getAllDoorSchedules 15
getAllEventsByCategory 122
getAllEventsByType 123
getAllEventsCategories 19
getAllLocationsInScope 16
getAllOrganizations 121
getAllPerson 116
getAllPersonByType 118
getAllPersonStatusIds 117
getAllPersonTypeIds 117
getAllScheduleNames 146
getAllSchedules 15
getAllSchedulesForTimeEntry 15
getAllSchedulesForTimeEntryCollection 15
getAllSchedulesForTimeRangeGroup 16
getAllTimeEntries 15
getAllTimeEntryCollections 15
getAllTimeRangeGroups 15
getAllUpdatedBadges 14
getAllUpdatedPersonnels 14
getAncestorLocations 16
getAssociatedGWDoor 13
getBadgeByCardNum 153
getBadgeRoles 152
getBadgeValidityTypes 151
getCredentialTemplateNames 151
getDeviceChildren 113
getDoorMode 142
getEventTypes 18
getPersonInfoByBadge 14
getPersonInfoByPersonId 120, 121
getTimeEntryById 15
getTimeEntryByName 15
getTimeEntryCollectionById 15
getTimeEntryCollectionByName 15
getTimeRangeGroupById 15
getTimeRangeGroupByName 15
getUserAccessEvents 125
getVersionInfo 134
grantDoorAccess 141
I
idle time 113
J
Java client 114
L
license for API functionality 19
Location
getAllLocationsInScope 16
logging 115
logoutUser 17
N
namespaces 18
notifyAcEvent 139
P
Precursor 183
R
recordExtEvent 189
registerAcEventCallback 136
registerAcEventXMLCallback 137
resetDoorMode 141
S
secCtx 113
security context object 113
serial number 112
setDeviceAdminState 12
setDoorMode 141
setDoorModeConfig 142
SSL 114
U
unid 115
unique ID 115
unregisterAcEventCallback 138
updateBadge 154
updatePerson 119
updateSchedule 15
updateTimeEntry 14
updateTimeEntryCollection 15
updateTimeRangeGroup 15
username and password 113
W
Web Services 18
X
X.509 certificate 114
Feedback