Trendsic Platform Service

<back to all web services

WorkerEnableAccessRequest

Requires Authentication
Required role:Administrator
The following routes are available for this service:
POST,OPTIONS/v1/worker/enable-access
<?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 WorkerEnableAccessResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var bool|null */
        public ?bool $AlreadyEnabled=null,
        /** @var string|null */
        public ?string $Username=null,
        /** @var string|null */
        public ?string $TempPassword=null,
        /** @var string|null */
        public ?string $InviteEmailedTo=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

class WorkerEnableAccessRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ContactId=0,
        /** @var bool|null */
        public ?bool $IsCrewLead=null
    ) {
    }

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

PHP WorkerEnableAccessRequest DTOs

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

HTTP + OTHER

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

POST /v1/worker/enable-access HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":0,"IsCrewLead":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Success":false,"AlreadyEnabled":false,"Username":"String","TempPassword":"String","InviteEmailedTo":"String","Message":"String"}