Trendsic Platform Service

<back to all web services

CourierPingRadiusRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/worker/dispatch/od/ping-radius
<?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 CourierPingRadiusResponse implements JsonSerializable
{
    public function __construct(
        /** @var float|null */
        public ?float $Mi=null,
        /** @var DateTime|null */
        public ?DateTime $UntilUtc=null,
        /** @var float|null */
        public ?float $RadiusMi=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class CourierPingRadiusRequest implements JsonSerializable
{
    public function __construct(
        /** @var float|null */
        public ?float $Mi=null
    ) {
    }

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

PHP CourierPingRadiusRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /v1/worker/dispatch/od/ping-radius HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Mi":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Mi":0,"UntilUtc":"0001-01-01T00:00:00.0000000","RadiusMi":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}