Server Command Service SOAP Protocol

The ServerCommandService SOAP protocol offers a range of commands for XProtect authentication, configuration management, bookmark management and event generation.

Typical operations on this SOAP service are:

  • Login and retrieve authorization tokens (OAuth access token in XProtect 2021R1 and later, and XProtect token for the ImageServer Protocol and some SOAP protocols).
  • Retrieve configuration
  • Trigger user-defined events with or without metadata (e.g. camera GUIDs)
  • Create and query bookmarks related to a camera

To connect to the ServerCommandService, use an URL like:

  • https://{host:port}/ManagementServer/ServerCommandServiceOauth.svc (Windows or Basic user)
  • http://{host:port}/ManagementServer/ServerCommandService.svc (Windows user)
  • https://{host:port}/ManagementServer/ServerCommandService.svc (Basic user)

/ManagementServer/ServerCommandServiceOauth.svc, available in XProtect 2021R1 and later, provides better security for Basic users.

The WSDL specification can be downloaded from the management server using an URL like:

  • http://{host:port}/ManagementServer/ServerCommandServiceOauth.svc?singleWsdl
  • http://{host:port}/ManagementServer/ServerCommandService.svc?singleWsdl

If the management server runs with default configuration on the local machine, the WSDLs will be at these URLs:

Please refer to Authentication and authorization for an introduction to the login process.