milestonexprotectrestpython.xprconst

Module: xprconst.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.
2023/09/13 1.0.2.0 Changed all constants that start with "MSG_TRACE_METHOD_RESTREQUEST" to "MSG_TRACE_METHOD_REQUEST".
2023/09/13 1.0.4.0 Test case scenario updates.
2023/09/13 1.0.5.0 Removed test token references due to security audit.

VERSION: str = '1.0.5'

Current version of the Milestone XProtect REST Python3 Library.

PACKAGENAME: str = 'milestonexprotectrestpython'

Name of our package (used by PDoc Documentation build).

PDOC_BRAND_ICON_URL: str = 'https://www.milestonesys.com/video-technology/platform/xprotect/'

PDoc Documentation brand icon link url that is displayed in the help document TOC. Value = "https://www.milestonesys.com/video-technology/platform/xprotect/"

PDOC_BRAND_ICON_URL_SRC: str = 'milestonexprotect.ico'

PDoc Documentation brand icon link url that is displayed in the help document TOC. Value = "milestonexprotect.ico"

PDOC_BRAND_ICON_URL_TITLE: str = 'A XProtect Client'

PDoc Documentation brand icon link title that is displayed in the help document TOC. Value = "A XProtect Client"

UNKNOWN_VALUE: str = '<unknown>'

Indicates if an event argument value is unknown for event argument objects that are displayed as a string.

Value: "<unknown>"

MSG_TRACE_METHOD_REQUEST: str = '{0} REST request'

{0} REST request

MSG_TRACE_METHOD_REQUEST_HEADERS: str = '{0} REST request headers'

{0} REST request headers

MSG_TRACE_METHOD_REQUEST_BODY: str = '{0} REST request body'

{0} REST request body

MSG_TRACE_METHOD_RESPONSE: str = '{0} REST response'

{0} REST response

MSG_TRACE_METHOD_RESPONSE_BODY: str = '{0} REST response body'

{0} REST response body

MSG_TRACE_PROCESSING_DICTIONARY: str = 'Processing dictionary "{0}" node'

Processing dictionary "{0}" node"

MSG_TRACE_PROCESSING_DICTIONARY_COLLECTION: str = 'Processing dictionary collection "{0}" node, and any "{1}" item nodes'

Processing dictionary "{0}" collection node, and any "{1}" item nodes

MSG_TRACE_RESULT_COLLECTION: str = '{0} Collection results'

{0} Collection results

MSG_TRACE_RESULT_OBJECT: str = '{0} object created: {1}'

{0} object created: {1}