MicroApp API

<back to all web services

ResolveMicroAppRequest

The following routes are available for this service:
All Verbs/app/resolve/{Key}
<?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 ResolveMicroAppRequest implements IHasTenantKey, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $key=null,
        /** @var string|null */
        public ?string $query=null,
        /** @var string|null */
        public ?string $tenantKey=null,
        /** @var string|null */
        public ?string $additionalParams=null
    ) {
    }

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

PHP ResolveMicroAppRequest 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 /app/resolve/{Key} HTTP/1.1 
Host: apps.harbourassist.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResolveMicroAppRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarbourAssist.Api.MicroApp.Dtos.Requests">
  <AdditionalParams>String</AdditionalParams>
  <Key>String</Key>
  <Query>String</Query>
  <TenantKey>String</TenantKey>
</ResolveMicroAppRequest>