digitaluapi

LookupListsAdd

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/lookup_lists

<?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 LookupListsAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $Description=null,

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

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

        // @DataMember(Order=5)
        /** @var DateTime */
        public DateTime $LastModifiedDate=new DateTime(),

        // @DataMember(Order=6)
        /** @var string */
        public string $RowVersionGuid='',

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

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

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

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $IsEnabled=null,

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

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $LastModifiedDate=new DateTime(),

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $RowVersionGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['LookupListCategoryId'])) $this->LookupListCategoryId = $o['LookupListCategoryId'];
        if (isset($o['LastModifiedDate'])) $this->LastModifiedDate = JsonConverters::from('DateTime', $o['LastModifiedDate']);
        if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->LookupListCategoryId)) $o['LookupListCategoryId'] = $this->LookupListCategoryId;
        if (isset($this->LastModifiedDate)) $o['LastModifiedDate'] = JsonConverters::to('DateTime', $this->LastModifiedDate);
        if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /lookup_lists HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LookupListsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Description>String</Description>
  <IsEnabled>false</IsEnabled>
  <LookupListCategoryId>0</LookupListCategoryId>
  <LastModifiedDate>0001-01-01T00:00:00</LastModifiedDate>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
</LookupListsAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LookupListsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Description>String</Description>
  <IsEnabled>false</IsEnabled>
  <LastModifiedDate>0001-01-01T00:00:00</LastModifiedDate>
  <LookupListCategoryId>0</LookupListCategoryId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
</LookupListsAddResponse>