digitaluapi

<back to all web services

SegmentsCriteriaEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/segments_criteria/{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 SegmentsCriteriaEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $SegmentsId=0,

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

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

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

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

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

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

        // @DataMember(Order=10)
        /** @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['SegmentsId'])) $this->SegmentsId = $o['SegmentsId'];
        if (isset($o['Logical'])) $this->Logical = $o['Logical'];
        if (isset($o['OpenBrackets'])) $this->OpenBrackets = $o['OpenBrackets'];
        if (isset($o['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['Operator'])) $this->Operator = $o['Operator'];
        if (isset($o['FieldValue'])) $this->FieldValue = $o['FieldValue'];
        if (isset($o['CloseBrackets'])) $this->CloseBrackets = $o['CloseBrackets'];
        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->SegmentsId)) $o['SegmentsId'] = $this->SegmentsId;
        if (isset($this->Logical)) $o['Logical'] = $this->Logical;
        if (isset($this->OpenBrackets)) $o['OpenBrackets'] = $this->OpenBrackets;
        if (isset($this->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->Operator)) $o['Operator'] = $this->Operator;
        if (isset($this->FieldValue)) $o['FieldValue'] = $this->FieldValue;
        if (isset($this->CloseBrackets)) $o['CloseBrackets'] = $this->CloseBrackets;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $SegmentsId=0,

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

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['SegmentsId'])) $this->SegmentsId = $o['SegmentsId'];
        if (isset($o['Logical'])) $this->Logical = $o['Logical'];
        if (isset($o['OpenBrackets'])) $this->OpenBrackets = $o['OpenBrackets'];
        if (isset($o['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['Operator'])) $this->Operator = $o['Operator'];
        if (isset($o['FieldValue'])) $this->FieldValue = $o['FieldValue'];
        if (isset($o['CloseBrackets'])) $this->CloseBrackets = $o['CloseBrackets'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->SegmentsId)) $o['SegmentsId'] = $this->SegmentsId;
        if (isset($this->Logical)) $o['Logical'] = $this->Logical;
        if (isset($this->OpenBrackets)) $o['OpenBrackets'] = $this->OpenBrackets;
        if (isset($this->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->Operator)) $o['Operator'] = $this->Operator;
        if (isset($this->FieldValue)) $o['FieldValue'] = $this->FieldValue;
        if (isset($this->CloseBrackets)) $o['CloseBrackets'] = $this->CloseBrackets;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /segments_criteria/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	SegmentsId: 0,
	Logical: String,
	OpenBrackets: String,
	FieldName: String,
	Operator: String,
	FieldValue: String,
	CloseBrackets: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	SegmentsId: 0,
	Logical: String,
	OpenBrackets: String,
	FieldName: String,
	Operator: String,
	FieldValue: String,
	CloseBrackets: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}