digitaluapi

<back to all web services

UploadFieldsEdit

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

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

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

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

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

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

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

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

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

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

        // @DataMember(Order=12)
        /** @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['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['Required'])) $this->Required = $o['Required'];
        if (isset($o['UploadType'])) $this->UploadType = $o['UploadType'];
        if (isset($o['Label'])) $this->Label = $o['Label'];
        if (isset($o['UploadSubtype'])) $this->UploadSubtype = $o['UploadSubtype'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['SortOrder'])) $this->SortOrder = $o['SortOrder'];
        if (isset($o['Help'])) $this->Help = $o['Help'];
        if (isset($o['Placeholder'])) $this->Placeholder = $o['Placeholder'];
        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->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->Required)) $o['Required'] = $this->Required;
        if (isset($this->UploadType)) $o['UploadType'] = $this->UploadType;
        if (isset($this->Label)) $o['Label'] = $this->Label;
        if (isset($this->UploadSubtype)) $o['UploadSubtype'] = $this->UploadSubtype;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->SortOrder)) $o['SortOrder'] = $this->SortOrder;
        if (isset($this->Help)) $o['Help'] = $this->Help;
        if (isset($this->Placeholder)) $o['Placeholder'] = $this->Placeholder;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['Required'])) $this->Required = $o['Required'];
        if (isset($o['UploadType'])) $this->UploadType = $o['UploadType'];
        if (isset($o['Label'])) $this->Label = $o['Label'];
        if (isset($o['UploadSubtype'])) $this->UploadSubtype = $o['UploadSubtype'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['SortOrder'])) $this->SortOrder = $o['SortOrder'];
        if (isset($o['Help'])) $this->Help = $o['Help'];
        if (isset($o['Placeholder'])) $this->Placeholder = $o['Placeholder'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->Required)) $o['Required'] = $this->Required;
        if (isset($this->UploadType)) $o['UploadType'] = $this->UploadType;
        if (isset($this->Label)) $o['Label'] = $this->Label;
        if (isset($this->UploadSubtype)) $o['UploadSubtype'] = $this->UploadSubtype;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->SortOrder)) $o['SortOrder'] = $this->SortOrder;
        if (isset($this->Help)) $o['Help'] = $this->Help;
        if (isset($this->Placeholder)) $o['Placeholder'] = $this->Placeholder;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UploadFieldsEdit 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 /upload_fields/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String"}

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

{"Id":0,"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}