API Operations for User Types

Summary

Operation Name: Retrieve a User Type by UserTypeID
Relative API Request Path: ~/api/v1/usertypes/{usertypeID}
HTTP Verb: GET
Description: Retrieve a single User Type by User Type ID.

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

Retrieve a User Type by UserTypeID

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

When retrieving an User Type using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the UserTypeName returned via the API method represents the UserTypeName as stored within the Issuetrak database. Thus, when retrieving a User Type created through the Issuetrak web interface where HTML encoding of the UserTypeName 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 ReadUserTypeDTO instance.

ReadUserTypeDTO
{
 ExtensionData (array[KeyValuePair[String,Object]]),
 Metadata (array[KeyValuePair[String,Object]]),
 “UserTypeID”: 0,
 “UserTypeName”: ”"
}

Request HTTP Verb: GET

Response Status Codes:

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

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

{
 “ExtensionData”: [],
 “Metadata”: [
  {
   “Key”: “APIVersion”,
   “Value”: “10.2”
  },
  {
   “Key”: “QueryDate”,
   “Value”: “2015-08-10T17:34:42.1369273Z”
  }
 ],
 “UserTypeID”: 1,
 “UserTypeName”: “Agent”
}

Retrieve all User Types

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

When retrieving an User Type using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the UserTypeName returned via the API method represents the UserTypeName as stored within the Issuetrak database. Thus, when retrieving a User Type created through the Issuetrak web interface where HTML encoding of the UserTypeName 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 ReadUserTypeDTO instance.

{
 “IsPageIndexZeroBased”: false,
 “PageIndex”: 0,
 “CountForPage”: 0,
 “PageSize”: 0,
 “TotalCount”: 0,
 “Collection”: [
  {
   “ExtensionData”: [
    “KeyValuePair[String,Object]”
   ],
   “Metadata”: [
    “KeyValuePair[String,Object]”
   ],
   “UserTypeID”: 0,
   “UserTypeName”: ""
  }
 ]
}

Request HTTP Verb: GET

Response Status Codes:

• Success: 200
• Non-existent UserType: 404

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

{
 “IsPageIndexZeroBased”: true,
 “PageIndex”: 0,
 “CountForPage”: 2,
 “PageSize”: 2147483647,
 “TotalCount”: 2,
 “Collection”: [
  {
   “ExtensionData”: [],
   “Metadata”: [
    {
     “Key”: “APIVersion”,
     “Value”: “10.2”
    },
    {
     “Key”: “QueryDate”,
     “Value”: “2015-08-10T17:37:43.2050323Z”
    }
   ],
   “UserTypeID”: 1,
   “UserTypeName”: “Agent”
  },
  {
   “ExtensionData”: [],
   “Metadata”: [
    {
     “Key”: “APIVersion”,
     “Value”: “10.2”
    },
    {
     “Key”: “QueryDate”,
     “Value”: “2015-08-10T17:37:43.2050323Z”
    }
   ],
   “UserTypeID”: 2,
   “UserTypeName”: “EndUser”
  }
 ]
}