PUT ApiUserTimeout/SetTimeouts?UniqueID={UniqueID}&TimeoutMinutes={TimeoutMinutes}

Updates the TimeoutMinutes for a given connection (AgvConn.UniqueID)

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
UniqueID

string

Required

TimeoutMinutes

string

Required

Body Parameters

Response Information

Resource Description

Updates the TimeoutMinutes for a given connection (AgvConn.UniqueID)

AgvApiUserTimeout
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many records returned (GET) or logged off (PUT).

string
APIUserTimeouts

JSON dictionary of API Users

Collection of ApiTimeout

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "APIUserTimeouts": [
    {
      "UniqueID": "sample string 1",
      "ApplicationKey": "sample string 2",
      "TimeoutMinutes": "sample string 3",
      "ApplicationName": "sample string 4"
    },
    {
      "UniqueID": "sample string 1",
      "ApplicationKey": "sample string 2",
      "TimeoutMinutes": "sample string 3",
      "ApplicationName": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvApiUserTimeout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.User">
  <APIUserTimeouts>
    <ApiTimeout>
      <ApplicationKey>sample string 2</ApplicationKey>
      <ApplicationName>sample string 4</ApplicationName>
      <TimeoutMinutes>sample string 3</TimeoutMinutes>
      <UniqueID>sample string 1</UniqueID>
    </ApiTimeout>
    <ApiTimeout>
      <ApplicationKey>sample string 2</ApplicationKey>
      <ApplicationName>sample string 4</ApplicationName>
      <TimeoutMinutes>sample string 3</TimeoutMinutes>
      <UniqueID>sample string 1</UniqueID>
    </ApiTimeout>
  </APIUserTimeouts>
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvApiUserTimeout>