Pigeon Voice Server REST Service Settings - DatasmithSA/Pigeon-Voice-Training GitHub Wiki

Settings related to the REST web service API if using HTTP requests from voice devices.

  • Rest Service Host Address Suffix: The suffix to append to the URI on which this Web Service will be accessed i.e. http://localhost:{port_number}/{suffix} e.g. http://localhost:8889/MyService.
  • Rest Service Port Number: The port number on which this Web Service should listen for requests from clients i.e. http://localhost:{port_number}/{suffix} e.g. http://localhost:2983/MyService.
  • Rest Service Use Authentication: Whether or not the service should authenticate clients attempting to consume the service.
  • Rest Service Include Exception Detail In Response: Whether or not to include the exception details including the stack trace in the web response when an unhandled exception occurs.
  • Rest Service Text Response Encoding: Encoding to used on the text response from the service.
  • Rest Service Include Type Names In Json Response: Whether or not to include the type names in the JSON serialized responses from the web service.
  • Rest Service Max Buffer Pool Size: The maximum amount of memory allocated, in bytes, for the buffer manager that manages the buffers required by endpoints that use this binding.
  • Rest Service Max Buffer Size: The maximum amount of memory allocated, in bytes, for use by the manager of the message buffers that receive messages from the channel.
  • Rest Service Max Received Message Size: The maximum size, in bytes, for a message that can be processed by the binding.
  • Rest Service Trace Http Messages: Whether to trace and log HTTP messages.
  • Rest Service Trace Http Message Headers: Whether to trace and log HTTP headers.
  • Rest Service Audit Service Calls: Whether to audit (log) calls on this web service.
  • Rest Service Service Ftp Directory: Directory where files get uploaded to by an FTP client.
  • Rest Service Max Concurrent Calls: The number of concurrent calls that can be made – under .NET 4 defaults to 16 x number of cores.
  • Rest Service Max Concurrent Sessions: he number of concurrent sessions that can be in in flight – under .NET 4 defaults to 100 x number of cores.
  • Rest Service Max Concurrent Instances: The number of service implementation objects that are in use – defaults to the sum of MaxConcurrentCalls + MaxConcurrentSessions.
  • Rest Service Performance Counter Scope: The scope of the performance counters to enable on the service in order to view the counters with Windows perfmon.exe.
  • Rest Service Handle Exceptions On Client Connection Accepted: Whether or not the server will handle exceptions (logging and email notifications) after HTTP client connections have been accepted. If set to true, exception handling is optional in your custom agents.
  • Rest Service Return Response On Agent Exceptions: Whether or not to return a result to the client when exceptions are thrown by web agents.
  • Rest Client Date Time Format: The date time format used in the messages being sent by the client in web requests.