Help Webservice

Open a support ticket

Open a support ticket

post/api/help/ticket

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/ticket
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

bodystring nullable

Body content of the support ticket

collaboratorsstring[] nullable

List of collaborator email addresses

consoleAccessGrantedboolean nullable

Whether console access has been granted for troubleshooting

productTypestring nullable
serialNumbersstring[] nullable

List of device serial numbers related to the issue

serviceTypestring nullable
subjectstring nullable

Subject of the support ticket

Example request

{
  "body": "My camera is not connecting to the network properly.",
  "consoleAccessGranted": true,
  "subject": "Camera connectivity issue"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
failureReasonstring nullable

Reason for failure if ticket creation was unsuccessful

successboolean nullable

Whether the ticket creation was successful

ticketIdinteger nullable

ID of the created support ticket

warningMsgstring nullable

Example response

{
  "failureReason": "Invalid email address",
  "success": true,
  "ticketId": 12345
}

Changes

No recorded changes to this operation across all 1 revision of this API.