| Required role: | User |
| POST | /app/ensure-action-url |
|---|
<?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};
enum ActionUrlHttpMethods : string
{
case GET = 'GET';
case POST = 'POST';
}
/** @description Ensures that the specified app user endpoint has the action URL mentioned */
// @Api(Description="Ensures that the specified app user endpoint has the action URL mentioned")
class EnsureActionUrl implements IPost, JsonSerializable
{
public function __construct(
/** @description The URL to use */
// @ApiMember(Description="The URL to use")
/** @var string|null */
public ?string $url=null,
/** @description Clear existing action URLs first */
// @ApiMember(Description="Clear existing action URLs first")
/** @var bool|null */
public ?bool $clearExisting=null,
/** @description The HTTP method to use */
// @ApiMember(Description="The HTTP method to use")
/** @var ActionUrlHttpMethods|null */
public ?ActionUrlHttpMethods $method=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['url'])) $this->url = $o['url'];
if (isset($o['clearExisting'])) $this->clearExisting = $o['clearExisting'];
if (isset($o['method'])) $this->method = JsonConverters::from('ActionUrlHttpMethods', $o['method']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->url)) $o['url'] = $this->url;
if (isset($this->clearExisting)) $o['clearExisting'] = $this->clearExisting;
if (isset($this->method)) $o['method'] = JsonConverters::to('ActionUrlHttpMethods', $this->method);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /app/ensure-action-url HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
url: String,
clearExisting: False,
method: GET
}