digitaluapi

<back to all web services

BatchDataLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/batch_data
<?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 BatchDataLookup implements JsonSerializable
{
    public function __construct(
        // @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['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->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 BatchDataLookup 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 /batch_data HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Data: String,
		HasError: False,
		Merged: False,
		BatchId: 0,
		Jsondata: String,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]