| POST | /user/profile |
|---|
<?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 ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, JsonSerializable
{
public function __construct(
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
/** @var string */
public string $apiKey='',
/** @description Latitude of the user making this request */
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
/** @var float */
public float $latitude=0.0,
/** @description Longitude of the user making this request */
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
/** @var float */
public float $longitude=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['apiKey'])) $this->apiKey = $o['apiKey'];
if (isset($o['latitude'])) $this->latitude = $o['latitude'];
if (isset($o['longitude'])) $this->longitude = $o['longitude'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->apiKey)) $o['apiKey'] = $this->apiKey;
if (isset($this->latitude)) $o['latitude'] = $this->latitude;
if (isset($this->longitude)) $o['longitude'] = $this->longitude;
return empty($o) ? new class(){} : $o;
}
}
class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $description=null,
/** @var string|null */
public ?string $heading=null,
/** @var bool|null */
public ?bool $wasSuccessful=null,
/** @var Object|null */
public ?Object $modelState=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['heading'])) $this->heading = $o['heading'];
if (isset($o['wasSuccessful'])) $this->wasSuccessful = $o['wasSuccessful'];
if (isset($o['modelState'])) $this->modelState = JsonConverters::from('Object', $o['modelState']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->heading)) $o['heading'] = $this->heading;
if (isset($this->wasSuccessful)) $o['wasSuccessful'] = $this->wasSuccessful;
if (isset($this->modelState)) $o['modelState'] = JsonConverters::to('Object', $this->modelState);
return empty($o) ? new class(){} : $o;
}
}
class UserCustomFieldData implements JsonSerializable
{
public function __construct(
/** @var string */
public string $id='',
/** @var string|null */
public ?string $value=null,
/** @var string|null */
public ?string $name=null,
/** @var bool|null */
public ?bool $optional=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['value'])) $this->value = $o['value'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['optional'])) $this->optional = $o['optional'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->value)) $o['value'] = $this->value;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->optional)) $o['optional'] = $this->optional;
return empty($o) ? new class(){} : $o;
}
}
class VenueCustomField implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $venueName=null,
/** @var int */
public int $venueId=0,
/** @var array<UserCustomFieldData>|null */
public ?array $fields=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['venueName'])) $this->venueName = $o['venueName'];
if (isset($o['venueId'])) $this->venueId = $o['venueId'];
if (isset($o['fields'])) $this->fields = JsonConverters::fromArray('UserCustomFieldData', $o['fields']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->venueName)) $o['venueName'] = $this->venueName;
if (isset($this->venueId)) $o['venueId'] = $this->venueId;
if (isset($this->fields)) $o['fields'] = JsonConverters::toArray('UserCustomFieldData', $this->fields);
return empty($o) ? new class(){} : $o;
}
}
class UpdateProfileResponse extends ApiServiceResponse implements JsonSerializable
{
/**
* @param string|null $description
* @param string|null $heading
* @param bool|null $wasSuccessful
* @param Object|null $modelState
*/
public function __construct(
?string $description=null,
?string $heading=null,
?bool $wasSuccessful=null,
?Object $modelState=null,
/** @var string|null */
public ?string $emailAddress=null,
/** @var string|null */
public ?string $mobileNumber=null,
/** @var string|null */
public ?string $name=null,
/** @var array<VenueCustomField>|null */
public ?array $venueCustomFields=null
) {
parent::__construct($description,$heading,$wasSuccessful,$modelState);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
if (isset($o['mobileNumber'])) $this->mobileNumber = $o['mobileNumber'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['venueCustomFields'])) $this->venueCustomFields = JsonConverters::fromArray('VenueCustomField', $o['venueCustomFields']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
if (isset($this->mobileNumber)) $o['mobileNumber'] = $this->mobileNumber;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->venueCustomFields)) $o['venueCustomFields'] = JsonConverters::toArray('VenueCustomField', $this->venueCustomFields);
return empty($o) ? new class(){} : $o;
}
}
class UpdateProfile extends ApiServiceRequest implements JsonSerializable
{
/**
* @param string $apiKey
* @param float $latitude
* @param float $longitude
*/
public function __construct(
string $apiKey='',
float $latitude=0.0,
float $longitude=0.0,
/** @var string|null */
public ?string $emailAddress=null,
/** @var string|null */
public ?string $mobileNumber=null,
/** @var string|null */
public ?string $name=null,
/** @var array<VenueCustomField>|null */
public ?array $venueCustomFields=null
) {
parent::__construct($apiKey,$latitude,$longitude);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
if (isset($o['mobileNumber'])) $this->mobileNumber = $o['mobileNumber'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['venueCustomFields'])) $this->venueCustomFields = JsonConverters::fromArray('VenueCustomField', $o['venueCustomFields']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
if (isset($this->mobileNumber)) $o['mobileNumber'] = $this->mobileNumber;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->venueCustomFields)) $o['venueCustomFields'] = JsonConverters::toArray('VenueCustomField', $this->venueCustomFields);
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 /user/profile HTTP/1.1
Host: reservation.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
emailAddress: String,
mobileNumber: String,
name: String,
venueCustomFields:
[
{
venueName: String,
venueId: 0,
fields:
[
{
id: 00000000-0000-0000-0000-000000000000,
value: String,
name: String,
optional: False
}
]
}
],
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
emailAddress: String,
mobileNumber: String,
name: String,
venueCustomFields:
[
{
venueName: String,
venueId: 0,
fields:
[
{
id: 00000000-0000-0000-0000-000000000000,
value: String,
name: String,
optional: False
}
]
}
],
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}