digitaluapi

<back to all web services

SegmentsCriteriaLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/segments_criteria
<?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 SegmentsCriteriaLookup implements JsonSerializable
{
    public function __construct(
        // @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
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        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->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 SegmentsCriteriaLookup 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.

GET /segments_criteria HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSegmentsCriteriaLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <SegmentsCriteriaLookupResponse>
    <CloseBrackets>String</CloseBrackets>
    <FieldName>String</FieldName>
    <FieldValue>String</FieldValue>
    <Logical>String</Logical>
    <OpenBrackets>String</OpenBrackets>
    <Operator>String</Operator>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <SegmentsId>0</SegmentsId>
  </SegmentsCriteriaLookupResponse>
</ArrayOfSegmentsCriteriaLookupResponse>