Skip to content

AccessRules

AccessRules service implementation.

AccessRules

Bases: ONVIFService

0.0.1 2.6

AccessRules service client.

Property Details
First introduced ONVIF 2.6 (June 2015)
Binding name AccessRulesBinding (ver10/accessrules/wsdl/accessrules.wsdl)
Operations accessrules.wsdl
Spec AccessRules

GetServiceCapabilities 

GetServiceCapabilities()

This operation returns the capabilities of the access rules service.

Output
  • Capabilities [ServiceCapabilities]
    The capability response message contains the requested access rules service capabilities using a hierarchical XML capability structure.
    • MaxLimit - required;
      The maximum number of entries returned by a single Get<Entity>List or Get<Entity> request. The device shall never return more than this number of entities in a single response.
    • MaxAccessProfiles - required;
      Indicates the maximum number of access profiles supported by the device.
    • MaxAccessPoliciesPerAccessProfile - required;
      Indicates the maximum number of access policies per access profile supported by the device.
    • MultipleSchedulesPerAccessPointSupported - required; [boolean]
      Indicates whether or not several access policies can refer to the same access point in an access profile.
    • ClientSuppliedTokenSupported - optional; [boolean]
      Indicates that the client is allowed to supply the token when creating access profiles. To enable the use of the command SetAccessProfile, the value must be set to true.

GetAccessProfileInfo 

GetAccessProfileInfo(Token)

This operation requests a list of AccessProfileInfo items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AccessProfileInfo items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AccessProfileInfo - optional, unbounded; [AccessProfileInfo]
    List of AccessProfileInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetAccessProfileInfoList 

GetAccessProfileInfoList(Limit=None, StartReference=None)

This operation requests a list of all of AccessProfileInfo items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • AccessProfileInfo - optional, unbounded; [AccessProfileInfo]
    List of AccessProfileInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetAccessProfiles 

GetAccessProfiles(Token)

This operation returns the specified access profile item matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AccessProfile items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AccessProfile - optional, unbounded; [AccessProfile]
    List of Access Profile items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AccessPolicy - optional, unbounded; [AccessPolicy]
      A list of access policy structures, where each access policy defines during which schedule an access point can be accessed.
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the access policy.
        Minimum length: 0
        Maximum length: 64
      • Entity [ReferenceToken]
        Reference to the entity used by the rule engine, the entity type may be specified by the optional EntityType field explained below but is typically an access point.
        Minimum length: 0
        Maximum length: 64
      • EntityType - optional; [QName]
        Optional entity type; if missing, an access point type as defined by the ONVIF Access Control Service Specification should be assumed. This can also be represented by the QName value "tac:AccessPoint" where tac is the namespace of ONVIF Access Control Service Specification. This field is provided for future extensions; it will allow an access policy being extended to cover entity types other than access points as well.
      • Extension - optional; [AccessPolicyExtension]
    • Extension - optional; [AccessProfileExtension]

GetAccessProfileList 

GetAccessProfileList(Limit=None, StartReference=None)

This operation requests a list of all of access profile items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • AccessProfile - optional, unbounded; [AccessProfile]
    List of Access Profile items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AccessPolicy - optional, unbounded; [AccessPolicy]
      A list of access policy structures, where each access policy defines during which schedule an access point can be accessed.
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the access policy.
        Minimum length: 0
        Maximum length: 64
      • Entity [ReferenceToken]
        Reference to the entity used by the rule engine, the entity type may be specified by the optional EntityType field explained below but is typically an access point.
        Minimum length: 0
        Maximum length: 64
      • EntityType - optional; [QName]
        Optional entity type; if missing, an access point type as defined by the ONVIF Access Control Service Specification should be assumed. This can also be represented by the QName value "tac:AccessPoint" where tac is the namespace of ONVIF Access Control Service Specification. This field is provided for future extensions; it will allow an access policy being extended to cover entity types other than access points as well.
      • Extension - optional; [AccessPolicyExtension]
    • Extension - optional; [AccessProfileExtension]

CreateAccessProfile 

CreateAccessProfile(AccessProfile)

This operation creates the specified access profile in the device.

The token field of the access profile shall be empty, the service shall allocate a token for the access profile. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as generic fault code. In an access profile, if several access policies specifying different schedules for the same access point will result in a union of the schedules.

Input
  • AccessProfile [AccessProfile]
    The AccessProfile to create.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AccessPolicy - optional, unbounded; [AccessPolicy]
      A list of access policy structures, where each access policy defines during which schedule an access point can be accessed.
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the access policy.
        Minimum length: 0
        Maximum length: 64
      • Entity [ReferenceToken]
        Reference to the entity used by the rule engine, the entity type may be specified by the optional EntityType field explained below but is typically an access point.
        Minimum length: 0
        Maximum length: 64
      • EntityType - optional; [QName]
        Optional entity type; if missing, an access point type as defined by the ONVIF Access Control Service Specification should be assumed. This can also be represented by the QName value "tac:AccessPoint" where tac is the namespace of ONVIF Access Control Service Specification. This field is provided for future extensions; it will allow an access policy being extended to cover entity types other than access points as well.
      • Extension - optional; [AccessPolicyExtension]
    • Extension - optional; [AccessProfileExtension]
Output
  • Token [ReferenceToken]
    The Token of created AccessProfile.
    Minimum length: 0
    Maximum length: 64

ModifyAccessProfile 

ModifyAccessProfile(AccessProfile)

This operation will modify the access profile for the specified access profile token.

The token of the access profile to modify is specified in the token field of the AccessProile structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified access profile. If several access policies specifying different schedules for the same access point will result in a union of the schedules. If the device could not store the access profile information then a fault will be generated.

Input
  • AccessProfile [AccessProfile]
    The details of Access Profile
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AccessPolicy - optional, unbounded; [AccessPolicy]
      A list of access policy structures, where each access policy defines during which schedule an access point can be accessed.
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the access policy.
        Minimum length: 0
        Maximum length: 64
      • Entity [ReferenceToken]
        Reference to the entity used by the rule engine, the entity type may be specified by the optional EntityType field explained below but is typically an access point.
        Minimum length: 0
        Maximum length: 64
      • EntityType - optional; [QName]
        Optional entity type; if missing, an access point type as defined by the ONVIF Access Control Service Specification should be assumed. This can also be represented by the QName value "tac:AccessPoint" where tac is the namespace of ONVIF Access Control Service Specification. This field is provided for future extensions; it will allow an access policy being extended to cover entity types other than access points as well.
      • Extension - optional; [AccessPolicyExtension]
    • Extension - optional; [AccessProfileExtension]

SetAccessProfile 

SetAccessProfile(AccessProfile)

This operation will synchronize an access profile in a client with the device.

If an access profile with the specified token does not exist in the device, the access profile is created. If an access profile with the specified token exists, then the access profile is modified. A call to this method takes an access profile structure as input parameter. The token field of the access profile must not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.

Input
  • AccessProfile [AccessProfile]
    The AccessProfile item to create or modify
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AccessPolicy - optional, unbounded; [AccessPolicy]
      A list of access policy structures, where each access policy defines during which schedule an access point can be accessed.
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the access policy.
        Minimum length: 0
        Maximum length: 64
      • Entity [ReferenceToken]
        Reference to the entity used by the rule engine, the entity type may be specified by the optional EntityType field explained below but is typically an access point.
        Minimum length: 0
        Maximum length: 64
      • EntityType - optional; [QName]
        Optional entity type; if missing, an access point type as defined by the ONVIF Access Control Service Specification should be assumed. This can also be represented by the QName value "tac:AccessPoint" where tac is the namespace of ONVIF Access Control Service Specification. This field is provided for future extensions; it will allow an access policy being extended to cover entity types other than access points as well.
      • Extension - optional; [AccessPolicyExtension]
    • Extension - optional; [AccessProfileExtension]

DeleteAccessProfile 

DeleteAccessProfile(Token)

This operation will delete the specified access profile.

If the access profile is deleted, all access policies associated to the access profile will also be deleted. If it is associated with one or more entities some devices may not be able to delete the access profile, and consequently a ReferenceInUse fault shall be generated.

Input
  • Token [ReferenceToken]
    The token of the access profile to delete.
    Minimum length: 0
    Maximum length: 64