| Required role: | Partner |
| POST | /clientregister |
|---|
<?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 ClientRegister 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,
// @Validate(Validator="NotNull")
/** @var string */
public string $Company='',
/** @var int */
public int $PartnerUserID=0,
/** @var string[]|null */
public ?array $Roles=null,
/** @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['Company'])) $this->Company = $o['Company'];
if (isset($o['PartnerUserID'])) $this->PartnerUserID = $o['PartnerUserID'];
if (isset($o['Roles'])) $this->Roles = JsonConverters::fromArray('string', $o['Roles']);
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->Company)) $o['Company'] = $this->Company;
if (isset($this->PartnerUserID)) $o['PartnerUserID'] = $this->PartnerUserID;
if (isset($this->Roles)) $o['Roles'] = JsonConverters::toArray('string', $this->Roles);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
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 /clientregister HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"EMail":"String","FirstName":"String","LastName":"String","Password":"String","ConfirmPassword":"String","Company":"String","PartnerUserID":0,"Roles":["String"],"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":"0001-01-01T00:00:00.0000000","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":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","InvalidLoginAttempts":0,"LastLoginAttempt":"0001-01-01T00:00:00.0000000","LockedDate":"0001-01-01T00:00:00.0000000","RecoveryToken":"String","RefId":0,"RefIdStr":"String","Meta":{"String":"String"}}