Technician Web APIs

Technician Web APIs enable you to:

  • Request all of the system views for a workspace.
  • Perform a logout for technicians that are logged in to the application.

The get calls are returned in JSON Format. The following details describe the Web APIs:

GET /technicians/{workspaceName}/Views

 Click here for a description.


Description

Returns all the System Views for the specified Workspace Name in JSON format

Type of callGET
URL Syntaxhttp(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/{workspaceName}/Views
Request Parameters

Specify the workSpaceName

Valid values are as follows:

  • helpdesk
  • change
  • announcements
  • inventory
  • purchasing
  • solutions
  • configuration
  • reporting

Note

Workspace names are case sensitive.

Request BodyNone
Execution response

The following fields are retrieved for the module:

  • name
  • title
  • key
  • count
  • isMultiModQry
Important considerations
  • You must have View Permissions of the specified module to use this Web API.
  • You can only request system views with this Web API.
  • You cannot request user or private views with this Web API.
 Click here to view an example.

Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/technicians/helpdesk/Views

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"


Response:

{
"SystemViews": [
{ "name": "WebGrid.77", "title": "All Assignments", "key": null, "count": -1, "isMultiModQry": false }
,....
}

GET /technicians/logout

 Click here to expand...


Description

Enables a technician to log out

Type of callGET
Request HeaderAPI Key received through the login API call.
URL Syntaxhttp(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/technicians/logout
Request Parameters

None

Request BodyNone
Execution response

The following responses can occur:

  • true – indicates a successful logout for the technician
  • false – indicates that the logout for the technician was not performed
Important considerations

None

 Click here to view an example.

Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/technicians/logout

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{ "Success": true }
Was this page helpful? Yes No Submitting... Thank you

Comments