digitaluapi

<back to all web services

QueriesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/queries
<?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 QueriesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $QueryText=null,

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

        // @DataMember(Order=4)
        /** @var int */
        public int $TenantsId=0,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['QueryText'])) $this->QueryText = $o['QueryText'];
        if (isset($o['PrimarykeyParameter'])) $this->PrimarykeyParameter = $o['PrimarykeyParameter'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->QueryText)) $o['QueryText'] = $this->QueryText;
        if (isset($this->PrimarykeyParameter)) $o['PrimarykeyParameter'] = $this->PrimarykeyParameter;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class QueriesAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $QueryText='',

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

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['QueryText'])) $this->QueryText = $o['QueryText'];
        if (isset($o['PrimarykeyParameter'])) $this->PrimarykeyParameter = $o['PrimarykeyParameter'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->QueryText)) $o['QueryText'] = $this->QueryText;
        if (isset($this->PrimarykeyParameter)) $o['PrimarykeyParameter'] = $this->PrimarykeyParameter;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /queries HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	QueryText: String,
	PrimarykeyParameter: String,
	TenantsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	QueryText: String,
	PrimarykeyParameter: String,
	TenantsId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}