REST Endpoints - QuinnBast/SaskTel-Communication-Portal GitHub Wiki

REST Endpoints

/rest/login

Allows the user to login to the application. This endpoint returns a JWT and CSRF token which the user can send back on future requests to validate themselves.

Parameter Name Type Description Example
username String The user's username to login with. SampleUser123
password String The user's password. hunter123

/rest/logout

Logs the user out of the application, invalidating their tokens. No Request body required. Requires sending the token in the header.

/rest/token/refresh

Refreshes the user's session token to extend their login session. Requires a valid refresh token. No request body required.

/rest/broadsoft

Accesses the broadWorks API Execution server endpoints to proxy a request from the webserver. Requires a valid JWT.

Parameter Name Type Description Example
endpoint String The endpoint in broadworks to access. NOTE: is replaced with the currently authenticated user's username. /user/<user>/services
method String The method to access the endpoint with. "PUT", "GET", "POST", etc...
data Xml String An XML formatted string to send to the Broadworks API server. The format of this data is defined in the Broadworks API. <?xml version"1.0" encoding="ISO-8859-1"?><DoNotDisturb><active>false</active><ringSplash>false</ringSplash></DoNotDisturb>
⚠️ **GitHub.com Fallback** ⚠️