PUT api/Utilization/PutCurrentMode?SerialNumber={SerialNumber}

Change utilization mode for specified unit, using supplied settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SerialNumber

Unit serial number

string

Required

Body Parameters

Utilization mode

UtilizationModeUpdateModel
NameDescriptionTypeAdditional information
Id

The id of the Utilization mode to set on the device. Set to 0 to disable utilization

integer32

None.

Settings

The specific settings to set for this Utilization mode. When updating the device's current utilization mode, this list may be partial and need only specify the setting(s) being updated. When changing device's current utilization mode, ALL the settings for that mode must be specified.

Collection of UtilizationSettingUpdateModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Settings": [
    {
      "Index": 1,
      "Value": 2
    },
    {
      "Index": 1,
      "Value": 2
    }
  ]
}

application/xml, text/xml

Sample:
<UtilizationModeUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <Id>1</Id>
  <Settings>
    <UtilizationSettingUpdateModel>
      <Index>1</Index>
      <Value>2</Value>
    </UtilizationSettingUpdateModel>
    <UtilizationSettingUpdateModel>
      <Index>1</Index>
      <Value>2</Value>
    </UtilizationSettingUpdateModel>
  </Settings>
</UtilizationModeUpdateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Change utilization mode for specified unit, using supplied settings

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.