Query all author users

Contents

1. Prerequisites
2. Overview
3. Procedure
4. Example
   1. Test application
   2. Return with HTTP 401-Unauthorized error response due to not matching API key
   3. Return with HTTP 500-InternalServerError error response due to other error
   4. Return with HTTP 200-OK success response

Prerequisites

HTTP request authentication must be set up properly. You can find more information here.

Overview

Procedure

The list of SpeechExec Enterprise author users can be queried using the GET /dms/users endpoint. This endpoint does not require any parameters.

All the users are validated if they are members of the SpeechExec Enterprise subsystem and only the valid users are involved in the result.

The call returns with the following JSON response:

{
    "CRI": "<GUID>",
    "users": [
        {
            "username": "<string>"
        },
        ...
    ]
}

The CRI field stands for Client Request Identifier. It is a tracing ID used for tracking the server requests with the appropriate client ones.

The users field contains the list of retrieved user objects. Each user object has a username field.

The call returns with HTTP 401-Unauthorized if the authentication prerequisites are not fulfilled.

The call returns with HTTP 500-InternalServerError if any other error occurs.

The call returns with HTTP 200-OK if querying the list of users is successful.

In all error cases, the exact error reason can be found in the response body, in the FailureCode field.

Example

Test application

A test application can be found here: https://github.com/speechprocessing/speechexec-enterprise-integrator-guide/tree/main/testapps/EnterpriseAppInterface/CSharp/DMSAPITest

Return with HTTP 401-Unauthorized error response due to not matching API key

Request:

GET https://my.service.url/SEEAppInterface/dms/users

Headers:

x-sps-api-key: ""

Response:

401 Unauthorized

{
    "CRI": "7B2683D0-F090-45F7-8C81-69066596D91A",
    "FailureCode": "Invalid_api_key"
}

Return with HTTP 500-InternalServerError error response due to other error

Request:

GET https://my.service.url/SEEAppInterface/dms/users

Headers:

x-sps-api-key: "<api_key_supported_by_server>"

Response:

500 InternalServerError

{
    "CRI": "7B2683D0-F090-45F7-8C81-69066596D91A",
    "FailureCode": "Generic_error"
}

Return with HTTP 200-OK success response

Request:

GET https://my.service.url/SEEAppInterface/dms/users

Headers:

x-sps-api-key: "<api_key_supported_by_server>"

Response:

200 OK

{
    "CRI": "7B2683D0-F090-45F7-8C81-69066596D91A",
    "users": [
        {
            "username": "Sarah"
        },
        {
            "username": "John"
        }
    ]
}