ServiceStatus

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The Feature Status endpoint provides the API consumer with access to methods pertaining to feature statuses and related data objects. The methods allow consumers to pull feature status data.

Methods

URL base/Workforce/ServiceStatus/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the Service Status.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
  {
    "HttpAction": "Get",
    "MethodName": "GetServiceStatus",
    "Description": "Returns the record for a single 'Service Status' given the passed in ID value (see Path).",
    "Path": "/ServiceStatus/GetServiceStatus/25032"
  },
  {
    "HttpAction": "Get",
    "MethodName": "GetServiceStatuses",
    "Description": "Returns all 'Service Statuses' in the database (see Path).",
    "Path": "/ServiceStatus/GetServiceStatuses"
  }
]
URL base/Workforce/ServiceStatus/GetServiceStatuses
Action GET
Description Returns a list of Service Status objects in the M4 database.
Parameters None
Returns A list of JSON Service Status data objects.
Sample Return Object 
[
  {
    "ID": 1,
    "StatusName": "Pending",
    "IsPending": true
  },
  {
    "ID": 2,
    "StatusName": "Active",
    "IsPending": false
  }
]
URL base/Workforce/ServiceStatus/GetServiceStatus/ID
Action GET
Description Returns a Service Status object when given an ID of a valid Service Status in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a Service Status in the M4 database.
Returns A JSON Service Status data object
Sample Return Object 
{
  "ID": 1,
  "StatusName": "Pending",
  "IsPending": true
}

Was this article helpful?

Yes No

Related Articles