digitaluapi

BatchDataFieldsEdit

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
PUT	/batch_data_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 BatchDataFieldsEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

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

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

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

        // @DataMember(Order=6)
        /** @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['BatchId'])) $this->BatchId = $o['BatchId'];
        if (isset($o['UploadFieldsId'])) $this->UploadFieldsId = $o['UploadFieldsId'];
        if (isset($o['MappedFieldName'])) $this->MappedFieldName = $o['MappedFieldName'];
        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->BatchId)) $o['BatchId'] = $this->BatchId;
        if (isset($this->UploadFieldsId)) $o['UploadFieldsId'] = $this->UploadFieldsId;
        if (isset($this->MappedFieldName)) $o['MappedFieldName'] = $this->MappedFieldName;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

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

{"Id":0,"BatchId":0,"UploadFieldsId":0,"MappedFieldName":"String"}

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

{"Id":0,"BatchId":0,"UploadFieldsId":0,"MappedFieldName":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}