Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

SensorEvents

Requires Authentication
The following routes are available for this service:
All Verbs/SensorEvents/{User}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SensorEvents implements JsonSerializable
{
    public function __construct(
        /** @description User name required to identify him. */
        // @ApiMember(Description="User name required to identify him.", IsRequired=true)
        /** @var string */
        public string $User='',

        /** @description If given, only the expected position will be retured. */
        // @ApiMember(Description="If given, only the expected position will be retured.")
        /** @var string */
        public string $ExpectedPosition='',

        /** @description Optional: niveau de détail des événements (masque de bits Gestures=1, Detailed=2), aligné sur le webhook RegisterCallback. 0 = Legacy (défaut, position string, rétro-compatible) ; 1 = Gestures (JSON: Click/DoubleClick/LongPress + durationMs) ; 2 = Detailed (JSON: position, edge Down/Up, timestampUtc, seq) ; 3 = Both. Absent ou 0 => comportement inchangé pour les clients existants. */
        // @ApiMember(Description="Optional: niveau de détail des événements (masque de bits Gestures=1, Detailed=2), aligné sur le webhook RegisterCallback. 0 = Legacy (défaut, position string, rétro-compatible) ; 1 = Gestures (JSON: Click/DoubleClick/LongPress + durationMs) ; 2 = Detailed (JSON: position, edge Down/Up, timestampUtc, seq) ; 3 = Both. Absent ou 0 => comportement inchangé pour les clients existants.")
        /** @var int */
        public int $DetailLevel=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['User'])) $this->User = $o['User'];
        if (isset($o['ExpectedPosition'])) $this->ExpectedPosition = $o['ExpectedPosition'];
        if (isset($o['DetailLevel'])) $this->DetailLevel = $o['DetailLevel'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->User)) $o['User'] = $this->User;
        if (isset($this->ExpectedPosition)) $o['ExpectedPosition'] = $this->ExpectedPosition;
        if (isset($this->DetailLevel)) $o['DetailLevel'] = $this->DetailLevel;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SensorEvents DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SensorEvents/{User} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SensorEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <DetailLevel>0</DetailLevel>
  <ExpectedPosition>String</ExpectedPosition>
  <User>String</User>
</SensorEvents>