| POST | /cmd/users/register |
|---|
<?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 LoginCredentials implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $username=null,
/** @var string|null */
public ?string $password=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['username'])) $this->username = $o['username'];
if (isset($o['password'])) $this->password = $o['password'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->username)) $o['username'] = $this->username;
if (isset($this->password)) $o['password'] = $this->password;
return empty($o) ? new class(){} : $o;
}
}
class Name implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $first=null,
/** @var string|null */
public ?string $last=null,
/** @var string|null */
public ?string $full=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['first'])) $this->first = $o['first'];
if (isset($o['last'])) $this->last = $o['last'];
if (isset($o['full'])) $this->full = $o['full'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->first)) $o['first'] = $this->first;
if (isset($this->last)) $o['last'] = $this->last;
if (isset($this->full)) $o['full'] = $this->full;
return empty($o) ? new class(){} : $o;
}
}
class Ref implements JsonSerializable
{
public function __construct(
/** @var string */
public string $id='',
/** @var string */
public string $val=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['val'])) $this->val = $o['val'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->val)) $o['val'] = $this->val;
return empty($o) ? new class(){} : $o;
}
}
class GPSCoordinates implements JsonSerializable
{
public function __construct(
/** @var float */
public float $lat=0.0,
/** @var float */
public float $lng=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['lat'])) $this->lat = $o['lat'];
if (isset($o['lng'])) $this->lng = $o['lng'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->lat)) $o['lat'] = $this->lat;
if (isset($this->lng)) $o['lng'] = $this->lng;
return empty($o) ? new class(){} : $o;
}
}
class Address implements JsonSerializable
{
public function __construct(
/** @var string */
public string $street='',
/** @var string */
public string $city='',
/** @var string */
public string $state='',
/** @var string */
public string $postalCode='',
/** @var Ref|null */
public ?Ref $country=null,
/** @var GPSCoordinates|null */
public ?GPSCoordinates $gps=null,
/** @var RecordDictionary2<string, string>|null */
public ?RecordDictionary2 $data=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['street'])) $this->street = $o['street'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['country'])) $this->country = JsonConverters::from('Ref', $o['country']);
if (isset($o['gps'])) $this->gps = JsonConverters::from('GPSCoordinates', $o['gps']);
if (isset($o['data'])) $this->data = JsonConverters::from(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->street)) $o['street'] = $this->street;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->country)) $o['country'] = JsonConverters::to('Ref', $this->country);
if (isset($this->gps)) $o['gps'] = JsonConverters::to('GPSCoordinates', $this->gps);
if (isset($this->data)) $o['data'] = JsonConverters::to(JsonConverters::context('RecordDictionary2',genericArgs:['string','string']), $this->data);
return empty($o) ? new class(){} : $o;
}
}
class ContactInfo implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $phone=null,
/** @var string|null */
public ?string $email=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['phone'])) $this->phone = $o['phone'];
if (isset($o['email'])) $this->email = $o['email'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->phone)) $o['phone'] = $this->phone;
if (isset($this->email)) $o['email'] = $this->email;
return empty($o) ? new class(){} : $o;
}
}
class Person implements JsonSerializable
{
public function __construct(
/** @var Name|null */
public ?Name $name=null,
/** @var Address|null */
public ?Address $address=null,
/** @var DateTime|null */
public ?DateTime $dateOfBirth=null,
/** @var ContactInfo|null */
public ?ContactInfo $contactInfo=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['name'])) $this->name = JsonConverters::from('Name', $o['name']);
if (isset($o['address'])) $this->address = JsonConverters::from('Address', $o['address']);
if (isset($o['dateOfBirth'])) $this->dateOfBirth = JsonConverters::from('DateTime', $o['dateOfBirth']);
if (isset($o['contactInfo'])) $this->contactInfo = JsonConverters::from('ContactInfo', $o['contactInfo']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->name)) $o['name'] = JsonConverters::to('Name', $this->name);
if (isset($this->address)) $o['address'] = JsonConverters::to('Address', $this->address);
if (isset($this->dateOfBirth)) $o['dateOfBirth'] = JsonConverters::to('DateTime', $this->dateOfBirth);
if (isset($this->contactInfo)) $o['contactInfo'] = JsonConverters::to('ContactInfo', $this->contactInfo);
return empty($o) ? new class(){} : $o;
}
}
class AvatarImage implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $base64=null,
/** @var string|null */
public ?string $tag=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['base64'])) $this->base64 = $o['base64'];
if (isset($o['tag'])) $this->tag = $o['tag'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->base64)) $o['base64'] = $this->base64;
if (isset($this->tag)) $o['tag'] = $this->tag;
return empty($o) ? new class(){} : $o;
}
}
class NewUserDTO implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $externalUserId=null,
/** @var LoginCredentials|null */
public ?LoginCredentials $credentials=null,
/** @var Person|null */
public ?Person $person=null,
/** @var RecordList<string>|null */
public ?RecordList $roles=null,
/** @var AvatarImage|null */
public ?AvatarImage $avatar=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['externalUserId'])) $this->externalUserId = $o['externalUserId'];
if (isset($o['credentials'])) $this->credentials = JsonConverters::from('LoginCredentials', $o['credentials']);
if (isset($o['person'])) $this->person = JsonConverters::from('Person', $o['person']);
if (isset($o['roles'])) $this->roles = JsonConverters::from(JsonConverters::context('RecordList',genericArgs:['string']), $o['roles']);
if (isset($o['avatar'])) $this->avatar = JsonConverters::from('AvatarImage', $o['avatar']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->externalUserId)) $o['externalUserId'] = $this->externalUserId;
if (isset($this->credentials)) $o['credentials'] = JsonConverters::to('LoginCredentials', $this->credentials);
if (isset($this->person)) $o['person'] = JsonConverters::to('Person', $this->person);
if (isset($this->roles)) $o['roles'] = JsonConverters::to(JsonConverters::context('RecordList',genericArgs:['string']), $this->roles);
if (isset($this->avatar)) $o['avatar'] = JsonConverters::to('AvatarImage', $this->avatar);
return empty($o) ? new class(){} : $o;
}
}
class RegisterUserAccount implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $id=null,
/** @var NewUserDTO|null */
public ?NewUserDTO $newUserDTO=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['newUserDTO'])) $this->newUserDTO = JsonConverters::from('NewUserDTO', $o['newUserDTO']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->newUserDTO)) $o['newUserDTO'] = JsonConverters::to('NewUserDTO', $this->newUserDTO);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template TKey
* @template TVal
* @template array of TKey
* @template array1 of TVal
*/
class RecordDictionary2 extends array implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): RecordDictionary2 {
$to = new RecordDictionary2();
$to->genericArgs = $genericArgs;
return $to;
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
/**
* @template T
* @template array of T
*/
class RecordList extends \ArrayObject implements JsonSerializable
{
public function __construct(T ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof T)
parent::append($value);
else
throw new \Exception("Can only append a T to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new T();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
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 /cmd/users/register HTTP/1.1
Host: api.sbbet.ath.cx
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
newUserDTO:
{
externalUserId: String,
credentials:
{
username: String,
password: String
},
person:
{
name:
{
first: String,
last: String,
full: String String
},
address:
{
street: String,
city: String,
state: String,
postalCode: String,
country:
{
id: String,
val: String
},
gps:
{
lat: 0,
lng: 0
},
data:
{
String: String
}
},
dateOfBirth: 0001-01-01,
contactInfo:
{
phone: String,
email: String
}
},
roles:
[
String
],
avatar:
{
base64: String,
tag: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}