digitaluapi

<back to all web services

DeleteBatchLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/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};


// @DataContract
class DeleteBatchLookup 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=''
    ) {
    }

    /** @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 DeleteBatchLookup DTOs

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

HTTP + JSV

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

GET /delete_batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		CreatedDate: 0001-01-01,
		FileName: String,
		FileSize: String,
		RecordCount: 0,
		FieldMapping: String,
		UserAuthId: 0,
		RowVersionGuid: 00000000000000000000000000000000,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]