API Operations for ServiceLevelSeverities

Summary

Operation Name: Retrieve a ServiceLevelSeverity by ServiceLevelSeverity ID
Relative API Request Path: ~/api/v1/servicelevelseverities/{severityID}
HTTP Verb: GET
Description: Retrieve a single ServiceLevelSeverity by ServiceLevelSeverity ID.

Operation Name: Retrieve all ServiceLevelSeverities
Relative API Request Path: ~/api/v1/servicelevelseverities
HTTP Verb: GET
Description: Retrieve a collection of currently defined ServiceLevelSeverities.

Retrieve a ServiceLevelSeverity by ServiceLevelSeverity ID

This API method retrieves a ServiceLevelSeverity from the Issuetrak data store for a specified ServiceLevelSeverity ID. The severityID parameter must correspond to an existing ServiceLevelSeverity. If there is no such ServiceLevelSeverity ID, an error message will be returned with an HTTP response status code of 404.

When retrieving a ServiceLevelSeverity using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the ServiceLevelSeverityName returned via the API method represents the ServiceLevelSeverityName as stored within the Issuetrak database. Thus, when retrieving a ServiceLevelSeverity created through the Issuetrak web interface where HTML encoding of the ServiceLevelSeverityName is performed, the API consumer may desire to perform additional client-side decoding.

A successful response will include an HTTP status code of 200 (OK) and a response body containing a serialized ReadServiceLevelSeverityDTO instance.

ReadServiceLevelSeverityDTO
{
 ExtensionData (array[CustomKeyValuePairDataElement]),
 Metadata (array[CustomKeyValuePairDataElement]),
 SeverityID (integer),
 Severity (string),
 SeverityDescription (string),
 DisplayOrder (number)
}
CustomKeyValuePairDataElement
{
 Key (string),
 Value (string)
}

Request HTTP Verb: GET

Response Status Codes:

• Success: 200
• Invalid ServiceLevelSeverity ID: 400 (Bad Request, e.g., a negative integer is supplied)
• Non-existent ServiceLevelSeverity: 404
• Invalid ServiceLevelSeverity ID: 422 (Unprocessable Enatity, e.g., a non-numeric value is supplied)

Sample Request URL: ~/api/v1/servicelevelseverities/1

{
 “ExtensionData”: [],
 “Metadata”: [
  {
   “Key”: “APIVersion”,
   “Value”: “v1”
  },
  {
   “Key”: “QueryDate”,
   “Value”: “2015-02-09T14:07:58.2787766Z”
  }
 ],
 “SeverityID”: 1,
 “Severity”: “Low”,
 “SeverityDescription”: “Low Severity”,
 “DisplayOrder”: 1
}

Retrieve all ServiceLevelSeverities

This API method retrieves a collection of all currently-defined ServiceLevelSeverities from the Issuetrak data store.

When retrieving a ServiceLevelSeverity using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the ServiceLevelSeverityName returned via the API method represents the ServiceLevelSeverityName as stored within the Issuetrak database. Thus, when retrieving a Cause created through the Issuetrak web interface where HTML encoding of the ServiceLevelSeverityName is performed, the API consumer may desire to perform additional client-side decoding.

A successful response will include an HTTP status code of 200 (OK) and a response body containing a serialized collection of ReadServiceLevelSeverityDTO instance.

{
 “IsPageIndexZeroBased”: false,
 “PageIndex”: 0,
 “CountForPage”: 0,
 “PageSize”: 0,
 “TotalCount”: 0,
 “Collection”: [
  {
   “ExtensionData”: [
    {
     “Key”: "",
     “Value”: ""
    }
   ],
   “Metadata”: [
    {
     “Key”: "",
     “Value”: ""
    }
   ],
   “SeverityID”: 0,
   “Severity”: "",
   “SeverityDescription”: "",
   “DisplayOrder”: 0
  }
 ]
}

Request HTTP Verb: GET

Response Status Codes:

• Success: 200
• Non-existent ServiceLevelSeverities: 404

Sample Request URL: ~/api/v1/servicelevelseverities/

{
 “IsPageIndexZeroBased”: true,
 “PageIndex”: 0,
 “CountForPage”: 1,
 “PageSize”: 2147483647,
 “TotalCount”: 1,
 “Collection”: [
  {
   “ExtensionData”: [],
   “Metadata”: [
    {
     “Key”: “APIVersion”,
     “Value”: “v1”
    },
    {
     “Key”: “QueryDate”,
     “Value”: “2015-02-09T14:32:17.9301759Z”
    }
   ],
   “SeverityID”: 1,
   “Severity”: “Low”,
   “SeverityDescription”: “Low Severity”,
   “DisplayOrder”: 1
  },
 ]
}