PUT v1/core/accounts/{accId}/agents/{agtId}

Enable / Disable specified agent

Request Information

Parameters

Name	Description	Additional information
accId	Account ID	Define this parameter in the request URI.
agtId	Agent ID	Define this parameter in the request URI.
agentControl	AgentControl object	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "State": "Disable|Enable"
}

text/javascript

Sample:

{"State":0}

application/xml, text/xml

Sample:

<AgentControl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <State>Disable|Enable</State>
</AgentControl>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AgentControl'.

application/bson

Sample:

State

Response Information

Value of setting

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "State": "Disable|Enable"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"State":0},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfAgentControlCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <State>Disable|Enable</State>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfAgentControlCA1DLPoZ>

application/bson

Sample:

tSuccessDataStateErrorCodeErrorDescriptionsample string 3Metasample string 4