location#

Autogenerated API

argus_api.lib.sensors.v1.location.create_location(name: str = None, shortName: str = None, networkZone: str = None, customerID: int = None, timeZoneDescription: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Creates a location (INTERNAL)

Parameters

  • name (str) – Name of some physical Location => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – Short name of some physical Location => [a-zA-Z0-9_:\-.]*

  • networkZone (str) – Network zone for some physical Location

  • customerID (int) – CustomerID for some physical Location

  • timeZoneDescription (str) – TimeZone description for some physical Location (default Europe/Oslo)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.location.delete_location(idOrShortName: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Deletes location (INTERNAL)

Parameters

  • idOrShortName (str) – ID or short name of location to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.location.find_locations(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, searchString: str = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, customer: str = None, includeFlags: str = None, excludeFlags: str = None, includeGlobal: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search locations (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • searchString (str) – DEPRECATED: Deprecated. Use keywords.

  • keywords (list) – Search for Locations by exact match on these keywords

  • keywordMatchStrategy (str) – Defines how strictly different keywords should be matched (default match any keywords) (default any)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (defaults to all supported fields) (default all)

  • customer (list) – Search for Locations belonging to customers identified by their ID or shortname

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • includeGlobal (bool) – Include global locations with results regardless of other criteria (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.location.get_location(idOrShortName: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch Location by ID or short name (INTERNAL)

Parameters

  • idOrShortName (str) – ID or short name of location to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.location.list_locations(customerID: int = None, limit: int = 25, offset: int = None, includeGlobal: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List locations (INTERNAL)

Parameters

  • customerID (list) – Limit search to these customer IDs

  • limit (int) – Limit results

  • offset (int) – Offset results

  • includeGlobal (bool) – Include global locations

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.location.update_location(idOrShortName: str, name: str = None, shortName: str = None, networkZone: str = None, timeZoneIdOrName: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Updates location (INTERNAL)

Parameters

  • idOrShortName (str) – ID or short name of location to update

  • name (str) – New name for the Location => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – New short name for the Location => [a-zA-Z0-9_:\-.]*

  • networkZone (str) – New network zone for the location

  • timeZoneIdOrName (str) – New TimeZone for the Location

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON