Partner Webservice

Register deal

Register a deal

post/api/partner/registerDeal

Request

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

detailsobject nullable

Map of deal details with key-value pairs

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
warningMsgstring nullable

Example response

{
  "clients": [
    {
      "authorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "clientAccessAllowed": true,
      "clientAccountAccessUrl": "https://console.rhombussystems.com/client/access",
      "clientOrgName": "Acme Corporation",
      "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 1640995200000,
      "totalAudioGateways": 4,
      "totalBadgeReaders": 12,
      "totalCameras": 25,
      "totalClimateSensors": 10,
      "totalDoorSensors": 8,
      "totalLocations": 3,
      "totalOccupancySensors": 6,
      "totalProximitySensors": 5
    }
  ]
}

Changes

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