digitaluapi

DeleteBatchAdd

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

The following routes are available for this service:
POST	/delete_batch

<?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 DeleteBatchAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var DateTime|null */
        public ?DateTime $CreatedDate=null,

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

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

        // @DataMember(Order=5)
        /** @var int */
        public int $RecordCount=0,

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

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

        // @DataMember(Order=8)
        /** @var string */
        public string $RowVersionGuid='',

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['FileSize'])) $this->FileSize = $o['FileSize'];
        if (isset($o['RecordCount'])) $this->RecordCount = $o['RecordCount'];
        if (isset($o['FieldMapping'])) $this->FieldMapping = $o['FieldMapping'];
        if (isset($o['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->FileSize)) $o['FileSize'] = $this->FileSize;
        if (isset($this->RecordCount)) $o['RecordCount'] = $this->RecordCount;
        if (isset($this->FieldMapping)) $o['FieldMapping'] = $this->FieldMapping;
        if (isset($this->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class DeleteBatchAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var DateTime|null */
        public ?DateTime $CreatedDate=null,

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

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['FileSize'])) $this->FileSize = $o['FileSize'];
        if (isset($o['RecordCount'])) $this->RecordCount = $o['RecordCount'];
        if (isset($o['FieldMapping'])) $this->FieldMapping = $o['FieldMapping'];
        if (isset($o['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->FileSize)) $o['FileSize'] = $this->FileSize;
        if (isset($this->RecordCount)) $o['RecordCount'] = $this->RecordCount;
        if (isset($this->FieldMapping)) $o['FieldMapping'] = $this->FieldMapping;
        if (isset($this->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DeleteBatchAdd DTOs

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

HTTP + XML

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

POST /delete_batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeleteBatchAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <RecordCount>0</RecordCount>
  <FieldMapping>String</FieldMapping>
  <UserAuthId>0</UserAuthId>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
</DeleteBatchAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DeleteBatchAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <FieldMapping>String</FieldMapping>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <RecordCount>0</RecordCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <UserAuthId>0</UserAuthId>
</DeleteBatchAddResponse>