System

The System resource is used to verify the status of the xAPI service, retrieve your organization’s EPASS User IDs and Groups, and refresh the cached lookup tables.
Tags:
Categories:

Check the Status of the xAPI

GET /system/services/healthcheck

This endpoint returns the current status of the xAPI service.

Sample: Checking the Status of the xAPI

GET /system/services/healthcheck
Service application loaded since 1/26/2022 11:05:12 AM.

Retrieve EPASS Users Accounts

GET /system/services/users

This endpoint returns the attributes of your organization’s EPASS user accounts and user groups. You can also choose to include obsolete user and group accounts.

Parameters

If no parameters are passed, all current and obsolete user accounts and groups are returned.

Name Type Description
includeuser boolean If true, returns user accounts in the response.
includegroup boolean If true, returns group accounts in the response.
includeobsolete boolean If true, only obsolete records are included.

Sample: Retrieving EPASS User Accounts

GET /system/services/users?includeuser=true&includegroup=true&includeobsolete=false
{
  "Result": {
    "Success": true,
    "Warning": false,
    "HttpStatusCode": 200,
    "GeneralMessage": "Returned 782 record",
    "ExceptionMessage": null,
    "Keys": [],
    "Messages": [],
    "Warnings": []
  },
  "Values": [
    {
      "Fields": {
        "ID": 127,
        "Code": "SYADM",
        "UserType": "Group",
        "UserGroupCode": "",
        "SalesPersonCode": "",
        "TechnicianCode": "",
        "Expeditor": "",
        "Route": "",
        "SaveDefaults": true,
        "RetailDeckUserName": "",
        "RetailDeckPassword": "",
        "ReportExportLocation": "",
        "DefaultTextNumber": "",
        "TechCodeforLabor": "",
        "MyHelpUserName": "",
        "MyHelpPassword": "",
        "ThinkingPhonesUserName": "",
        "ThinkingPhonesPassword": "",
        "RestrictLocationVisibility": true,
        "MPHDiagnosticsUserName": "",
        "MPHDiagnosticsPassword": "",
        "Obsolete": false,
        "Email": "",
        "BranchCode": "",
        "Description": "EPASS Administrators",
        "Password": ""
      }
    },
	
    ...
    
    {
      "Fields": {
        "ID": 123,
        "Code": "SALES01",
        "UserType": "Group",
        "UserGroupCode": "",
        "SalesPersonCode": "",
        "TechnicianCode": "",
        "Expeditor": "",
        "Route": "",
        "SaveDefaults": true,
        "RetailDeckUserName": "",
        "RetailDeckPassword": "",
        "ReportExportLocation": "",
        "DefaultTextNumber": "",
        "TechCodeforLabor": "",
        "MyHelpUserName": "",
        "MyHelpPassword": "",
        "ThinkingPhonesUserName": "",
        "ThinkingPhonesPassword": "",
        "RestrictLocationVisibility": false,
        "MPHDiagnosticsUserName": "",
        "MPHDiagnosticsPassword": "",
        "Obsolete": false,
        "Email": "",
        "BranchCode": "",
        "Description": "SALES STAFF",
        "Password": ""
      }
    },
    {
      "Fields": {
        "ID": 1420,
        "Code": "CHRIS",
        "UserType": "User",
        "UserGroupCode": "",
        "SalesPersonCode": "00248",
        "TechnicianCode": "",
        "Expeditor": "",
        "Route": "",
        "SaveDefaults": true,
        "RetailDeckUserName": "",
        "RetailDeckPassword": "",
        "ReportExportLocation": "",
        "DefaultTextNumber": "",
        "TechCodeforLabor": "",
        "MyHelpUserName": "",
        "MyHelpPassword": "",
        "ThinkingPhonesUserName": "",
        "ThinkingPhonesPassword": "",
        "RestrictLocationVisibility": false,
        "MPHDiagnosticsUserName": "",
        "MPHDiagnosticsPassword": "",
        "Obsolete": false,
        "Email": "",
        "BranchCode": "",
        "Description": "Chris",
        "Password": ""
      }
    }
  ]
}

Refresh Lookup Tables

These endpoints enable you to manually refresh the data in the cached lookup tables as well as refresh any changes that are made to the Cached Lookups settings in appsettings.json.

Refresh the Cached Lookup Tables

POST /system/services/lookups/refresh

Sending this endpoint updates the Cached Lookup table data.

Parameters

Name Type Description
rebuild Boolean Default value is FALSE. If value equals ‘TRUE’, data in the lookup tables is deleted and the tables are re-populated again from the database. If ‘FALSE’, data is deleted but the tables are not re-populated.

Sample: Refreshing the Cached Lookup Tables

POST /system/services/lookups/refresh?rebuild=true
{
  "Success": true,
  "Warning": false,
  "HttpStatusCode": 0,
  "GeneralMessage": "The lookups were re-cached successfully.",
  "ExceptionMessage": null,
  "Keys": [],
  "Messages": [],
  "Warnings": []
}

Refresh the Cached Lookup Settings

POST /system/services/settings/refresh

Sending this endpoint updates the Cached Lookup settings data.

Parameters

Name Type Description
rebuild Boolean Default value is FALSE. If value equals ‘TRUE’, the settings are deleted and then re-populated again from the database. If ‘FALSE’, settings are deleted but not re-populated.

Sample: Refresh the Cached Lookups Settings

 POST system/services/settings/refresh?rebuild=true
 
{
  "Success": true,
  "Warning": false,
  "HttpStatusCode": 0,
  "GeneralMessage": "The lookups were re-cached successfully.",
  "ExceptionMessage": null,
  "Keys": [],
  "Messages": [],
  "Warnings": []
}