Status Grades Lookup

Status Grades Lookup

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclients.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=statusgrades

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/clients.json?&version=6&company=1&action=statusgrades

Example request (legacy username/password):

http://<SERVER>/jsonapi/clients.json?&version=6&company=1&action=statusgrades&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 4,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "lookupOpStatusGrade": "Bronze",
      "variable_selected": false
    },
    {
      "lookupOpStatusGrade": "Silver",
      "variable_selected": false
    },
    {
      "lookupOpStatusGrade": "Gold",
      "variable_selected": false
    },
    {
      "lookupOpStatusGrade": "Platinum",
      "variable_selected": false
    }
  ]
}