| POST | /usergroupuserregister |
|---|
<?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 UserAuth implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $userName=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $primaryEmail=null,
/** @var string|null */
public ?string $phoneNumber=null,
/** @var string|null */
public ?string $firstName=null,
/** @var string|null */
public ?string $lastName=null,
/** @var string|null */
public ?string $displayName=null,
/** @var string|null */
public ?string $company=null,
/** @var DateTime|null */
public ?DateTime $birthDate=null,
/** @var string|null */
public ?string $birthDateRaw=null,
/** @var string|null */
public ?string $address=null,
/** @var string|null */
public ?string $address2=null,
/** @var string|null */
public ?string $city=null,
/** @var string|null */
public ?string $state=null,
/** @var string|null */
public ?string $country=null,
/** @var string|null */
public ?string $culture=null,
/** @var string|null */
public ?string $fullName=null,
/** @var string|null */
public ?string $gender=null,
/** @var string|null */
public ?string $language=null,
/** @var string|null */
public ?string $mailAddress=null,
/** @var string|null */
public ?string $nickname=null,
/** @var string|null */
public ?string $postalCode=null,
/** @var string|null */
public ?string $timeZone=null,
/** @var string|null */
public ?string $salt=null,
/** @var string|null */
public ?string $passwordHash=null,
/** @var string|null */
public ?string $digestHa1Hash=null,
/** @var array<string>|null */
public ?array $roles=null,
/** @var array<string>|null */
public ?array $permissions=null,
/** @var DateTime */
public DateTime $createdDate=new DateTime(),
/** @var DateTime */
public DateTime $modifiedDate=new DateTime(),
/** @var int */
public int $invalidLoginAttempts=0,
/** @var DateTime|null */
public ?DateTime $lastLoginAttempt=null,
/** @var DateTime|null */
public ?DateTime $lockedDate=null,
/** @var string|null */
public ?string $recoveryToken=null,
/** @var int|null */
public ?int $refId=null,
/** @var string|null */
public ?string $refIdStr=null,
/** @var array<string,string>|null */
public ?array $meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['userName'])) $this->userName = $o['userName'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['primaryEmail'])) $this->primaryEmail = $o['primaryEmail'];
if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['displayName'])) $this->displayName = $o['displayName'];
if (isset($o['company'])) $this->company = $o['company'];
if (isset($o['birthDate'])) $this->birthDate = JsonConverters::from('DateTime', $o['birthDate']);
if (isset($o['birthDateRaw'])) $this->birthDateRaw = $o['birthDateRaw'];
if (isset($o['address'])) $this->address = $o['address'];
if (isset($o['address2'])) $this->address2 = $o['address2'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['culture'])) $this->culture = $o['culture'];
if (isset($o['fullName'])) $this->fullName = $o['fullName'];
if (isset($o['gender'])) $this->gender = $o['gender'];
if (isset($o['language'])) $this->language = $o['language'];
if (isset($o['mailAddress'])) $this->mailAddress = $o['mailAddress'];
if (isset($o['nickname'])) $this->nickname = $o['nickname'];
if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['timeZone'])) $this->timeZone = $o['timeZone'];
if (isset($o['salt'])) $this->salt = $o['salt'];
if (isset($o['passwordHash'])) $this->passwordHash = $o['passwordHash'];
if (isset($o['digestHa1Hash'])) $this->digestHa1Hash = $o['digestHa1Hash'];
if (isset($o['roles'])) $this->roles = JsonConverters::fromArray('string', $o['roles']);
if (isset($o['permissions'])) $this->permissions = JsonConverters::fromArray('string', $o['permissions']);
if (isset($o['createdDate'])) $this->createdDate = JsonConverters::from('DateTime', $o['createdDate']);
if (isset($o['modifiedDate'])) $this->modifiedDate = JsonConverters::from('DateTime', $o['modifiedDate']);
if (isset($o['invalidLoginAttempts'])) $this->invalidLoginAttempts = $o['invalidLoginAttempts'];
if (isset($o['lastLoginAttempt'])) $this->lastLoginAttempt = JsonConverters::from('DateTime', $o['lastLoginAttempt']);
if (isset($o['lockedDate'])) $this->lockedDate = JsonConverters::from('DateTime', $o['lockedDate']);
if (isset($o['recoveryToken'])) $this->recoveryToken = $o['recoveryToken'];
if (isset($o['refId'])) $this->refId = $o['refId'];
if (isset($o['refIdStr'])) $this->refIdStr = $o['refIdStr'];
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->userName)) $o['userName'] = $this->userName;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->primaryEmail)) $o['primaryEmail'] = $this->primaryEmail;
if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->displayName)) $o['displayName'] = $this->displayName;
if (isset($this->company)) $o['company'] = $this->company;
if (isset($this->birthDate)) $o['birthDate'] = JsonConverters::to('DateTime', $this->birthDate);
if (isset($this->birthDateRaw)) $o['birthDateRaw'] = $this->birthDateRaw;
if (isset($this->address)) $o['address'] = $this->address;
if (isset($this->address2)) $o['address2'] = $this->address2;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->culture)) $o['culture'] = $this->culture;
if (isset($this->fullName)) $o['fullName'] = $this->fullName;
if (isset($this->gender)) $o['gender'] = $this->gender;
if (isset($this->language)) $o['language'] = $this->language;
if (isset($this->mailAddress)) $o['mailAddress'] = $this->mailAddress;
if (isset($this->nickname)) $o['nickname'] = $this->nickname;
if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->timeZone)) $o['timeZone'] = $this->timeZone;
if (isset($this->salt)) $o['salt'] = $this->salt;
if (isset($this->passwordHash)) $o['passwordHash'] = $this->passwordHash;
if (isset($this->digestHa1Hash)) $o['digestHa1Hash'] = $this->digestHa1Hash;
if (isset($this->roles)) $o['roles'] = JsonConverters::toArray('string', $this->roles);
if (isset($this->permissions)) $o['permissions'] = JsonConverters::toArray('string', $this->permissions);
if (isset($this->createdDate)) $o['createdDate'] = JsonConverters::to('DateTime', $this->createdDate);
if (isset($this->modifiedDate)) $o['modifiedDate'] = JsonConverters::to('DateTime', $this->modifiedDate);
if (isset($this->invalidLoginAttempts)) $o['invalidLoginAttempts'] = $this->invalidLoginAttempts;
if (isset($this->lastLoginAttempt)) $o['lastLoginAttempt'] = JsonConverters::to('DateTime', $this->lastLoginAttempt);
if (isset($this->lockedDate)) $o['lockedDate'] = JsonConverters::to('DateTime', $this->lockedDate);
if (isset($this->recoveryToken)) $o['recoveryToken'] = $this->recoveryToken;
if (isset($this->refId)) $o['refId'] = $this->refId;
if (isset($this->refIdStr)) $o['refIdStr'] = $this->refIdStr;
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
return empty($o) ? new class(){} : $o;
}
}
class UserGroupUserRegister implements JsonSerializable
{
public function __construct(
// @Validate(Validator="Email")
/** @var string|null */
public ?string $eMail=null,
// @Validate(Validator="[NotNull,NotEmpty]")
/** @var string|null */
public ?string $firstName=null,
// @Validate(Validator="[NotNull,NotEmpty]")
/** @var string|null */
public ?string $lastName=null,
// @Validate(Validator="[NotNull,NotEmpty]")
/** @var string|null */
public ?string $password=null,
/** @var string|null */
public ?string $confirmPassword=null,
/** @var string */
public string $inviteGUID='',
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['eMail'])) $this->eMail = $o['eMail'];
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['password'])) $this->password = $o['password'];
if (isset($o['confirmPassword'])) $this->confirmPassword = $o['confirmPassword'];
if (isset($o['inviteGUID'])) $this->inviteGUID = $o['inviteGUID'];
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->eMail)) $o['eMail'] = $this->eMail;
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->password)) $o['password'] = $this->password;
if (isset($this->confirmPassword)) $o['confirmPassword'] = $this->confirmPassword;
if (isset($this->inviteGUID)) $o['inviteGUID'] = $this->inviteGUID;
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
PHP UserGroupUserRegister DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /usergroupuserregister HTTP/1.1
Host: sfgboxapi.dev.scadsoftware.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"eMail":"String","firstName":"String","lastName":"String","password":"String","confirmPassword":"String","inviteGUID":"00000000000000000000000000000000","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"id":0,"userName":"String","email":"String","primaryEmail":"String","phoneNumber":"String","firstName":"String","lastName":"String","displayName":"String","company":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","fullName":"String","gender":"String","language":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","roles":["String"],"permissions":["String"],"createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","recoveryToken":"String","refId":0,"refIdStr":"String","meta":{"String":"String"}}