Trendsic Platform Service

<back to all web services

AgentDeviceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET, DELETE, OPTIONS/v1/AgentDevice/{DeviceId}
POST, OPTIONS/v1/AgentDevice
<?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 AgentDevice implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentDeviceId=0,
        /** @var string */
        public string $UserId='',
        /** @var string|null */
        public ?string $DeviceId=null,
        /** @var string|null */
        public ?string $Model=null,
        /** @var string|null */
        public ?string $Platform=null,
        /** @var string|null */
        public ?string $UUID=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentDeviceId'])) $this->AgentDeviceId = $o['AgentDeviceId'];
        if (isset($o['UserId'])) $this->UserId = $o['UserId'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['Model'])) $this->Model = $o['Model'];
        if (isset($o['Platform'])) $this->Platform = $o['Platform'];
        if (isset($o['UUID'])) $this->UUID = $o['UUID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentDeviceId)) $o['AgentDeviceId'] = $this->AgentDeviceId;
        if (isset($this->UserId)) $o['UserId'] = $this->UserId;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->Model)) $o['Model'] = $this->Model;
        if (isset($this->Platform)) $o['Platform'] = $this->Platform;
        if (isset($this->UUID)) $o['UUID'] = $this->UUID;
        return empty($o) ? new class(){} : $o;
    }
}

class AgentDeviceResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var AgentDevice|null */
        public ?AgentDevice $AgentDevice=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['AgentDevice'])) $this->AgentDevice = JsonConverters::from('AgentDevice', $o['AgentDevice']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->AgentDevice)) $o['AgentDevice'] = JsonConverters::to('AgentDevice', $this->AgentDevice);
        return empty($o) ? new class(){} : $o;
    }
}

class AgentDeviceRequest implements JsonSerializable
{
    public function __construct(
        /** @var AgentDevice|null */
        public ?AgentDevice $AgentDevice=null,
        /** @var string|null */
        public ?string $DeviceId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentDevice'])) $this->AgentDevice = JsonConverters::from('AgentDevice', $o['AgentDevice']);
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentDevice)) $o['AgentDevice'] = JsonConverters::to('AgentDevice', $this->AgentDevice);
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AgentDeviceRequest DTOs

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

HTTP + CSV

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

POST /v1/AgentDevice HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AgentDevice":{"AgentDeviceId":0,"UserId":"00000000000000000000000000000000","DeviceId":"String","Model":"String","Platform":"String","UUID":"String"},"DeviceId":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AgentDevice":{"AgentDeviceId":0,"UserId":"00000000000000000000000000000000","DeviceId":"String","Model":"String","Platform":"String","UUID":"String"}}