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