POST Agents/User/ExecuteUserCommandAsync

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/User/ExecuteUserCommandAsync

Executes the custom command for User

Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

The name of the command to execute. Result of an UI operation. The User to execute commands on.

Property Name Type Description
CommandName String
ActionResult String
User User SuperOffice User, with login credentials and an associated person. Carrier object for User. Services for the User Carrier is available from the User Agent.

Response:

OK

Response Description
200 OK

Response body: CommandResult

Property Name Type Description
Success bool The command was successfully executed.
Message string Message which should be displayed in GUI.
Result string The result used in this action.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/User/ExecuteUserCommandAsync
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "CommandName": "Raynor, Hegmann and Gerlach",
  "ActionResult": "Cancel",
  "User": null
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Success": false,
  "Message": "consequuntur",
  "Result": "Cancel",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 602
    }
  }
}