sfgboxapi

<back to all web services

UsersDetailsAdd

Requires Authentication
The following routes are available for this service:
POST/users_details
<?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 UsersDetailsAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        /** @var bool|null */
        public ?bool $approved=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $identificationNumber=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $passportNumber=null,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $address=null,

        // @DataMember(Order=7)
        /** @var float */
        public float $latitude=0.0,

        // @DataMember(Order=8)
        /** @var float */
        public float $longitude=0.0,

        // @DataMember(Order=9)
        /** @var int */
        public int $age=0,

        // @DataMember(Order=10)
        /** @var string|null */
        public ?string $ethnicGroup=null,

        // @DataMember(Order=11)
        /** @var string|null */
        public ?string $gender=null,

        // @DataMember(Order=12)
        /** @var bool|null */
        public ?bool $isDisabled=null,

        // @DataMember(Order=13)
        /** @var string|null */
        public ?string $documentUrl=null,

        // @DataMember(Order=14)
        /** @var DateTime */
        public DateTime $applicationDate=new DateTime(),

        // @DataMember(Order=15)
        /** @var DateTime */
        public DateTime $approvalDate=new DateTime(),

        // @DataMember(Order=16)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['approved'])) $this->approved = $o['approved'];
        if (isset($o['identificationNumber'])) $this->identificationNumber = $o['identificationNumber'];
        if (isset($o['passportNumber'])) $this->passportNumber = $o['passportNumber'];
        if (isset($o['address'])) $this->address = $o['address'];
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
        if (isset($o['age'])) $this->age = $o['age'];
        if (isset($o['ethnicGroup'])) $this->ethnicGroup = $o['ethnicGroup'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['isDisabled'])) $this->isDisabled = $o['isDisabled'];
        if (isset($o['documentUrl'])) $this->documentUrl = $o['documentUrl'];
        if (isset($o['applicationDate'])) $this->applicationDate = JsonConverters::from('DateTime', $o['applicationDate']);
        if (isset($o['approvalDate'])) $this->approvalDate = JsonConverters::from('DateTime', $o['approvalDate']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->approved)) $o['approved'] = $this->approved;
        if (isset($this->identificationNumber)) $o['identificationNumber'] = $this->identificationNumber;
        if (isset($this->passportNumber)) $o['passportNumber'] = $this->passportNumber;
        if (isset($this->address)) $o['address'] = $this->address;
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        if (isset($this->age)) $o['age'] = $this->age;
        if (isset($this->ethnicGroup)) $o['ethnicGroup'] = $this->ethnicGroup;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->isDisabled)) $o['isDisabled'] = $this->isDisabled;
        if (isset($this->documentUrl)) $o['documentUrl'] = $this->documentUrl;
        if (isset($this->applicationDate)) $o['applicationDate'] = JsonConverters::to('DateTime', $this->applicationDate);
        if (isset($this->approvalDate)) $o['approvalDate'] = JsonConverters::to('DateTime', $this->approvalDate);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class UsersDetailsAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $approved=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $identificationNumber=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $passportNumber=null,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $address='',

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $latitude=0.0,

        // @DataMember(Order=8)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $longitude=0.0,

        // @DataMember(Order=9)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $age=0,

        // @DataMember(Order=10)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $ethnicGroup='',

        // @DataMember(Order=11)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $gender='',

        // @DataMember(Order=12)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $isDisabled=null,

        // @DataMember(Order=13)
        /** @var string|null */
        public ?string $documentUrl=null,

        // @DataMember(Order=14)
        /** @var DateTime */
        public DateTime $applicationDate=new DateTime(),

        // @DataMember(Order=15)
        /** @var DateTime */
        public DateTime $approvalDate=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['approved'])) $this->approved = $o['approved'];
        if (isset($o['identificationNumber'])) $this->identificationNumber = $o['identificationNumber'];
        if (isset($o['passportNumber'])) $this->passportNumber = $o['passportNumber'];
        if (isset($o['address'])) $this->address = $o['address'];
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
        if (isset($o['age'])) $this->age = $o['age'];
        if (isset($o['ethnicGroup'])) $this->ethnicGroup = $o['ethnicGroup'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['isDisabled'])) $this->isDisabled = $o['isDisabled'];
        if (isset($o['documentUrl'])) $this->documentUrl = $o['documentUrl'];
        if (isset($o['applicationDate'])) $this->applicationDate = JsonConverters::from('DateTime', $o['applicationDate']);
        if (isset($o['approvalDate'])) $this->approvalDate = JsonConverters::from('DateTime', $o['approvalDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->approved)) $o['approved'] = $this->approved;
        if (isset($this->identificationNumber)) $o['identificationNumber'] = $this->identificationNumber;
        if (isset($this->passportNumber)) $o['passportNumber'] = $this->passportNumber;
        if (isset($this->address)) $o['address'] = $this->address;
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        if (isset($this->age)) $o['age'] = $this->age;
        if (isset($this->ethnicGroup)) $o['ethnicGroup'] = $this->ethnicGroup;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->isDisabled)) $o['isDisabled'] = $this->isDisabled;
        if (isset($this->documentUrl)) $o['documentUrl'] = $this->documentUrl;
        if (isset($this->applicationDate)) $o['applicationDate'] = JsonConverters::to('DateTime', $this->applicationDate);
        if (isset($this->approvalDate)) $o['approvalDate'] = JsonConverters::to('DateTime', $this->approvalDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP UsersDetailsAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users_details HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersDetailsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <Approved>false</Approved>
  <IdentificationNumber>String</IdentificationNumber>
  <PassportNumber>String</PassportNumber>
  <Address>String</Address>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Age>0</Age>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IsDisabled>false</IsDisabled>
  <DocumentUrl>String</DocumentUrl>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
</UsersDetailsAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersDetailsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Address>String</Address>
  <Age>0</Age>
  <AppUserId>0</AppUserId>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
  <Approved>false</Approved>
  <DocumentUrl>String</DocumentUrl>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IdentificationNumber>String</IdentificationNumber>
  <IsDisabled>false</IsDisabled>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <PassportNumber>String</PassportNumber>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UsersDetailsAddResponse>