Help Webservice

Open an RMA for a camera

Open an RMA for a camera

post/api/help/rma

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/rma
  • 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

contactNamestring nullable

Contact name for the RMA

contactPhoneNumberstring nullable

Contact phone number for the RMA

deviceNamestring nullable

Name of the device for RMA

problemstring nullable

Description of the problem with the device

serialNumberstring nullable

Serial number of the device

Example request

{
  "contactName": "John Doe",
  "contactPhoneNumber": "+1-555-123-4567",
  "deviceName": "Rhombus Camera Pro",
  "problem": "Camera not recording properly",
  "returnShippingAddress": {
    "returnAddressCity": "San Francisco",
    "returnAddressCountry": "United States",
    "returnAddressPostalCode": "94105",
    "returnAddressState": "CA",
    "returnAddressStreet": "123 Main Street"
  },
  "serialNumber": "RHCAM123456789"
}

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 RMA processing was unsuccessful

successboolean nullable

Whether the RMA processing was successful

ticketIdinteger nullable

ID of the RMA ticket created

warningMsgstring nullable

Example response

{
  "failureReason": "Invalid serial number",
  "success": true,
  "ticketId": 12345
}

Changes

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