digitaluapi

BatchDataEdit

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

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

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

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

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

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

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

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

// @DataContract
class BatchDataEdit 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 $Data=null,

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

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

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

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

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

PHP BatchDataEdit 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_data/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchDataEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <Data>String</Data>
  <HasError>false</HasError>
  <Merged>false</Merged>
  <BatchId>0</BatchId>
  <Jsondata>String</Jsondata>
</BatchDataEdit>

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

<BatchDataEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <BatchId>0</BatchId>
  <Data>String</Data>
  <HasError>false</HasError>
  <Id>0</Id>
  <Jsondata>String</Jsondata>
  <Merged>false</Merged>
  <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>
</BatchDataEditResponse>