Endpoint: '/rest/v1/test-connection'

Owned by Marc Davis

Apr 17, 2024

1 min read

Description:

This endpoint verifies the connection to the Employee Self Service application.

Method: ‘GET’

Parameters:

None

Request Headers:

‘Accept’:'application/json'
‘X-SSDT-API-Token’:'TOKEN' (replace TOKEN with your valid API Access token)

Responses:

HTTP Status Code: 200 OK
Content-Type: application/json

Response Body:

{
    "description": "Test Connection - Successful"
}

Error Response:

HTTP Status Code: 401 Unauthorized
Content-Type: application/json
Body

{
    "Invalid API Access Token"
}

Example Request:

GET /rest/v1/test-connection
Accept: application/json
X-SSDT-API-Token: "YOUR-API-TOKEN"

Example Response (Success):

Example Response (Error-Invalid API Key):