GET api/Utilization/GetAvailableModes?SerialNumber={SerialNumber}

Get a list of available utilization modes for a unit

Request Information

URI Parameters

Name	Description	Type	Additional information
SerialNumber	Unit serial number	string	Required

Body Parameters

None.

Response Information

Resource Description

Get a list of available utilization modes for a unit

Collection of UtilizationModeModel

Name	Description	Type	Additional information
Id	The id of the Utilization mode to set on the device	integer32	None.
Name		string	None.
SerialNumber		string	None.
Settings	The specific settings for this Utilization mode.	Collection of UtilizationSettingModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "SerialNumber": "sample string 3",
    "Settings": [
      {
        "Index": 1,
        "Name": "sample string 2",
        "Value": 3,
        "DefaultValue": 4,
        "MinValue": 5,
        "MaxValue": 6
      },
      {
        "Index": 1,
        "Name": "sample string 2",
        "Value": 3,
        "DefaultValue": 4,
        "MinValue": 5,
        "MaxValue": 6
      }
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "SerialNumber": "sample string 3",
    "Settings": [
      {
        "Index": 1,
        "Name": "sample string 2",
        "Value": 3,
        "DefaultValue": 4,
        "MinValue": 5,
        "MaxValue": 6
      },
      {
        "Index": 1,
        "Name": "sample string 2",
        "Value": 3,
        "DefaultValue": 4,
        "MinValue": 5,
        "MaxValue": 6
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfUtilizationModeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <UtilizationModeModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SerialNumber>sample string 3</SerialNumber>
    <Settings>
      <UtilizationSettingModel>
        <DefaultValue>4</DefaultValue>
        <Index>1</Index>
        <MaxValue>6</MaxValue>
        <MinValue>5</MinValue>
        <Name>sample string 2</Name>
        <Value>3</Value>
      </UtilizationSettingModel>
      <UtilizationSettingModel>
        <DefaultValue>4</DefaultValue>
        <Index>1</Index>
        <MaxValue>6</MaxValue>
        <MinValue>5</MinValue>
        <Name>sample string 2</Name>
        <Value>3</Value>
      </UtilizationSettingModel>
    </Settings>
  </UtilizationModeModel>
  <UtilizationModeModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SerialNumber>sample string 3</SerialNumber>
    <Settings>
      <UtilizationSettingModel>
        <DefaultValue>4</DefaultValue>
        <Index>1</Index>
        <MaxValue>6</MaxValue>
        <MinValue>5</MinValue>
        <Name>sample string 2</Name>
        <Value>3</Value>
      </UtilizationSettingModel>
      <UtilizationSettingModel>
        <DefaultValue>4</DefaultValue>
        <Index>1</Index>
        <MaxValue>6</MaxValue>
        <MinValue>5</MinValue>
        <Name>sample string 2</Name>
        <Value>3</Value>
      </UtilizationSettingModel>
    </Settings>
  </UtilizationModeModel>
</ArrayOfUtilizationModeModel>