digitaluapi

BatchEdit

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

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

        // @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 int|null */
        public ?int $UserAuthId=null,

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

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

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

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

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

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

        // @DataMember(Order=14)
        /** @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['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTimeOffset', $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['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
        if (isset($o['InsertedRecords'])) $this->InsertedRecords = $o['InsertedRecords'];
        if (isset($o['UpdatedRecords'])) $this->UpdatedRecords = $o['UpdatedRecords'];
        if (isset($o['DeletedRecords'])) $this->DeletedRecords = $o['DeletedRecords'];
        if (isset($o['UploadType'])) $this->UploadType = $o['UploadType'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        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->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTimeOffset', $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->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        if (isset($this->InsertedRecords)) $o['InsertedRecords'] = $this->InsertedRecords;
        if (isset($this->UpdatedRecords)) $o['UpdatedRecords'] = $this->UpdatedRecords;
        if (isset($this->DeletedRecords)) $o['DeletedRecords'] = $this->DeletedRecords;
        if (isset($this->UploadType)) $o['UploadType'] = $this->UploadType;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

        // @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 int|null */
        public ?int $UserAuthId=null,

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

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

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

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

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

        // @DataMember(Order=12)
        /** @var int|null */
        public ?int $StatusCodesId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTimeOffset', $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['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
        if (isset($o['InsertedRecords'])) $this->InsertedRecords = $o['InsertedRecords'];
        if (isset($o['UpdatedRecords'])) $this->UpdatedRecords = $o['UpdatedRecords'];
        if (isset($o['DeletedRecords'])) $this->DeletedRecords = $o['DeletedRecords'];
        if (isset($o['UploadType'])) $this->UploadType = $o['UploadType'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTimeOffset', $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->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        if (isset($this->InsertedRecords)) $o['InsertedRecords'] = $this->InsertedRecords;
        if (isset($this->UpdatedRecords)) $o['UpdatedRecords'] = $this->UpdatedRecords;
        if (isset($this->DeletedRecords)) $o['DeletedRecords'] = $this->DeletedRecords;
        if (isset($this->UploadType)) $o['UploadType'] = $this->UploadType;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /batch/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <RecordCount>0</RecordCount>
  <UserAuthId>0</UserAuthId>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <InsertedRecords>0</InsertedRecords>
  <UpdatedRecords>0</UpdatedRecords>
  <DeletedRecords>0</DeletedRecords>
  <UploadType>String</UploadType>
  <StatusCodesId>0</StatusCodesId>
</BatchEdit>

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

<BatchEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DeletedRecords>0</DeletedRecords>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <Id>0</Id>
  <InsertedRecords>0</InsertedRecords>
  <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>
  <StatusCodesId>0</StatusCodesId>
  <UpdatedRecords>0</UpdatedRecords>
  <UploadType>String</UploadType>
  <UserAuthId>0</UserAuthId>
</BatchEditResponse>