digitaluapi

<back to all web services

SystemConfigLookup

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

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

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

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

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

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

PHP SystemConfigLookup 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 /system_config HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		TenantsId: 0,
		FromEmailAddress: String,
		PasswordResetUrlTemplate: String,
		PasswordResetSubject: String,
		PasswordResetBodyTemplate: String,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]