Sign up| Sign in

home news setup features pricing company

Get

back to API list

This method returns all operators under your account based on the provided parameters.

URL

https://api.plupper.com/resources/operator

https://api.plupper.com/resources/operator/<username>

Formats

json

HTTP Method

GET

Requires Authentication

HTTP BASIC

API rate limited

No

Parameters

none

Response

get all
["{\"showMeOnlyWhenAvailable\":true,\"externalAccount\":\"\",\"offlineMessage\":\"John personal offline message\",\"departmentName\":\"TechSupport\",\"uri\":\"https:\/\/localhost:8181\/resources\/operator\/admin\",\"externalAccountEnabled\":false,\"username\":\"admin\",\"email\":\"john.lennon@example.com\",\"created\":\"Tue Feb 24 15:12:42 CET 2009\",\"admin\":true,\"name\":\"John Lennon\",\"departmentId\":2,\"displayName\":\"John\",\"welcomeMessage\":\"John personal welcome message\"}", "{\"showMeOnlyWhenAvailable\":true,\"externalAccount\":null,\"offlineMessage\":\"\",\"departmentName\":\"TechSupport\",\"uri\":\"https:\/\/localhost:8181\/resources\/operator\/sam34\",\"externalAccountEnabled\":false,\"username\":\"sam34\",\"email\":\"\",\"created\":\"Fri Jan 15 13:18:28 CET 2010\",\"admin\":false,\"name\":\"\",\"departmentId\":2,\"displayName\":\"Samuel\",\"welcomeMessage\":\"\"}", "{\"showMeOnlyWhenAvailable\":true,\"externalAccount\":null,\"offlineMessage\":\"\",\"departmentName\":\"CusotmerCare\",\"uri\":\"https:\/\/localhost:8181\/resources\/operator\/pamela65\",\"externalAccountEnabled\":false,\"username\":\"pamela65\",\"email\":\"\",\"created\":\"Fri Jan 15 13:19:28 CET 2010\",\"admin\":false,\"name\":\"\",\"departmentId\":67801,\"displayName\":\"Paula\",\"welcomeMessage\":\"\"}"]

get single
{"admin":"true","created":"Tue Feb 24 15:12:42 CET 2009","departmentId":"2","departmentName":"TechSupport","displayName":"John","email":"john.lennon@example.com","externalAccount":"","externalAccountEnabled":"false","name":"John Lennon","offlineMessage":"John personal offline message","showMeOnlyWhenAvailable":"true","uri":"https://localhost:8181/resources/operator/admin/admin","username":"admin","welcomeMessage":"John personal welcome message"}

Example queries

• Find all operators https://api.plupper.com/resources/operator
• Get operator with username='john' https://api.plupper.com/resources/operator/john
• jQuery example

  //get all
  $.ajax({
      type: "GET",
      url: "https://api.plupper.com/resources/operator,
      username: "john.lennon@example.com",
      password: "mysecret",
      dataType: "json",
      success: function(data) {
          for(var i in data) {
              var json = eval('(' + data[i] + ')');
              alert("Full name: " + json.fullName);
          }
      }
  });
  
  //get single
  $.ajax({
      type: "GET",
      url: "https://api.plupper.com/resources/operator/" + username,
      username: "john.lennon@example.com",
      password: "mysecret",
      dataType: "json",
      success: function(json) {
          alert("Full name: " + json.fullName);
      }
  });