ConsumerApi

<back to all web services

ProfileUpdatePersonalInformationRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
PUT/profile/personal-information
<?php namespace ConsumerApi;

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 DateOfBirth implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $year=0,
        /** @var int */
        public int $month=0,
        /** @var int */
        public int $dayOfMonth=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['year'])) $this->year = $o['year'];
        if (isset($o['month'])) $this->month = $o['month'];
        if (isset($o['dayOfMonth'])) $this->dayOfMonth = $o['dayOfMonth'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->year)) $o['year'] = $this->year;
        if (isset($this->month)) $o['month'] = $this->month;
        if (isset($this->dayOfMonth)) $o['dayOfMonth'] = $this->dayOfMonth;
        return empty($o) ? new class(){} : $o;
    }
}

enum Sex : string
{
    case Male = 'Male';
    case Female = 'Female';
}

enum DistanceUnit : string
{
    case Kilometer = 'Kilometer';
    case Mile = 'Mile';
}

PHP ProfileUpdatePersonalInformationRequest 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.

PUT /profile/personal-information HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProfileUpdatePersonalInformationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <DateOfBirth xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:DayOfMonth>0</d2p1:DayOfMonth>
    <d2p1:Month>0</d2p1:Month>
    <d2p1:Year>0</d2p1:Year>
  </DateOfBirth>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Sex>Male</Sex>
  <ShowDistancesIn>Kilometer</ShowDistancesIn>
</ProfileUpdatePersonalInformationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProfileUpdatePersonalInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <DateOfBirth xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:DayOfMonth>0</d2p1:DayOfMonth>
    <d2p1:Month>0</d2p1:Month>
    <d2p1:Year>0</d2p1:Year>
  </DateOfBirth>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Sex>Male</Sex>
  <ShowDistancesIn>Kilometer</ShowDistancesIn>
</ProfileUpdatePersonalInformationResponse>