Cisco Physical Access Manager API Reference Guide, Release 1.4.1
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.
Chapter: Index
Index
A
ackAlarm 2-33
addExceptionToSchedule 2-5
Additional Information 2-82
Precursor to APIs based on Location
Sample Usecases 2-82
API
authentication 1-14
function
list, See function
overview 2-6
summary 2-1
license 1-10
service 1-9
appliance serial number 1-13
applyConfigurationChanges 2-6
applyConfigurationChangesToLocation 2-6
applyScheduleToDoor 2-3
assignAccessLevels 2-48
authenticateUser 2-7
Authentication and Authorization 1-14
C
clearAlarm 2-31
Configuration changes
applyConfigurationChanges
applyConfigurationChangesToLocation 2-6
createSchedule 2-5
createTimeEntry 2-4
createTimeEntryCollection 2-5
createTimeRangeGroup 2-5
D
deleteSchedule 2-5
deleteTimeEntry 2-4
deleteTimeEntryCollection 2-5
deleteTimeRangeGroup 2-5
E
enrollBadge 2-46
enrollPerson 2-19
Event Definition Format 2-85
Event Notification 2-35
External events 2-84
F
fault codes 3-1
G
getAccessEventsByDoor 2-25
getAccessLevelByName 2-44
getAccessLevelByPerson 2-52
getAccessLevelByUnid 2-56
getAcDeviceTypes 2-8
getAlarmDuplicates 2-34
getAlarmInstructions 2-2
getAllAccessLevelNames 2-44
getAllAccessLevels 2-43
getAllAcDevices 2-12
getAllAlarmsByCategory 2-27
getAllAlarmsByType 2-28
getAllAlarmUpdates 2-29
getAllBadgeRefs 2-57
getAllBadgesByPerson 2-49
getAllBadgeTemplateNames 2-51
getAllBadgeTypeIds 2-57
getAllCameraDevices 2-10
getAllDepartments 2-21
getAllDoorGroups 2-15
getAllDoorsByGroup 2-15
getAllDoorSchedules 2-5
getAllEventsByCategory 2-21
getAllEventsByType 2-23
getAllEventsCategories 2-9
getAllLocationsInScope 2-6
getAllOrganizations 2-20
getAllPerson 2-16
getAllPersonByType 2-18
getAllPersonStatusIds 2-17
getAllPersonTypeIds 2-17
getAllScheduleNames 2-45
getAllSchedules 2-5
getAllSchedulesForTimeEntry 2-5
getAllSchedulesForTimeEntryCollection 2-5
getAllSchedulesForTimeRangeGroup 2-6
getAllTimeEntries 2-5
getAllTimeEntryCollections 2-5
getAllTimeRangeGroups 2-5
getAllUpdatedBadges 2-4
getAllUpdatedPersonnels 2-4
getAncestorLocations 2-6
getAssociatedGWDoor 2-3
getBadgeByCardNum 2-52
getBadgeRoles 2-51
getBadgeValidityTypes 2-50
getCredentialTemplateNames 2-50
getDeviceChildren 2-13
getDoorMode 2-41
getEventTypes 2-8
getPersonInfoByBadge 2-4
getPersonInfoByPersonId 2-20
getTimeEntryById 2-5
getTimeEntryByName 2-5
getTimeEntryCollectionById 2-5
getTimeEntryCollectionByName 2-5
getTimeRangeGroupById 2-5
getTimeRangeGroupByName 2-5
getUserAccessEvents 2-24
getVersionInfo 2-33
grantDoorAccess 2-40
I
idle time 1-14
J
Java client 1-15
L
license for API functionality 1-10
Location
getAllLocationsInScope 2-6
logging 1-16
logoutUser 2-7
N
namespaces 1-8
notifyAcEvent 2-38
P
Precursor 2-82
R
recordExtEvent 2-87
registerAcEventCallback 2-35
registerAcEventXMLCallback 2-36
resetDoorMode 2-40
S
secCtx 1-14
security context object 1-14
serial number 1-13
setDeviceAdminState 2-2
setDoorMode 2-40
setDoorModeConfig 2-41
SSL 1-15
U
unid 1-15
unique ID 1-15
unregisterAcEventCallback 2-37
updateBadge 2-53
updatePerson 2-19
updateSchedule 2-5
updateTimeEntry 2-4
updateTimeEntryCollection 2-5
updateTimeRangeGroup 2-5
username and password 1-14
W
Web Services 1-9
X
X.509 certificate 1-15
Feedback