digitaluapi

<back to all web services

AvatarsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/avatars/{Id}
<?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 AvatarsEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Name=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $Gender=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $AgeGroup=null,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $Style=null,

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $ImageUrl=null,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $EthnicGroup=null,

        // @DataMember(Order=10)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

// @DataContract
class AvatarsEdit implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Name='',

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Gender='',

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $AgeGroup='',

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Style='',

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $ImageUrl='',

        // @DataMember(Order=8)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $EthnicGroup=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Gender'])) $this->Gender = $o['Gender'];
        if (isset($o['AgeGroup'])) $this->AgeGroup = $o['AgeGroup'];
        if (isset($o['Style'])) $this->Style = $o['Style'];
        if (isset($o['ImageUrl'])) $this->ImageUrl = $o['ImageUrl'];
        if (isset($o['EthnicGroup'])) $this->EthnicGroup = $o['EthnicGroup'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Gender)) $o['Gender'] = $this->Gender;
        if (isset($this->AgeGroup)) $o['AgeGroup'] = $this->AgeGroup;
        if (isset($this->Style)) $o['Style'] = $this->Style;
        if (isset($this->ImageUrl)) $o['ImageUrl'] = $this->ImageUrl;
        if (isset($this->EthnicGroup)) $o['EthnicGroup'] = $this->EthnicGroup;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AvatarsEdit 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.

PUT /avatars/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"TenantsId":0,"Name":"String","Gender":"String","AgeGroup":"String","Style":"String","ImageUrl":"String","EthnicGroup":"String"}

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

{"Id":0,"TenantsId":0,"Name":"String","Gender":"String","AgeGroup":"String","Style":"String","ImageUrl":"String","EthnicGroup":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}