MyApp

<back to all web services

UpdateBooking

bookings

Update an existing Booking

Requires Authentication
Required role:Employee
The following routes are available for this service:
PATCH/booking/{Id}
<?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};


// @DataContract
class IdResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $id=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

enum RoomType : string
{
    case Single = 'Single';
    case Double = 'Double';
    case Queen = 'Queen';
    case Twin = 'Twin';
    case Suite = 'Suite';
}

/** @description Update an existing Booking */
// @ValidateRequest(Validator="HasRole(`Employee`)")
/**
 * @template IPatchDb of Booking
 */
class UpdateBooking implements IPatchDb, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var string|null */
        public ?string $name=null,
        /** @var RoomType|null */
        public ?RoomType $roomType=null,
        // @Validate(Validator="GreaterThan(0)")
        /** @var int|null */
        public ?int $roomNumber=null,

        // @Validate(Validator="GreaterThan(0)")
        /** @var float|null */
        public ?float $cost=null,

        /** @var DateTime|null */
        public ?DateTime $bookingStartDate=null,
        /** @var DateTime|null */
        public ?DateTime $bookingEndDate=null,
        /** @var string|null */
        public ?string $notes=null,
        /** @var bool|null */
        public ?bool $cancelled=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['roomType'])) $this->roomType = JsonConverters::from('RoomType', $o['roomType']);
        if (isset($o['roomNumber'])) $this->roomNumber = $o['roomNumber'];
        if (isset($o['cost'])) $this->cost = $o['cost'];
        if (isset($o['bookingStartDate'])) $this->bookingStartDate = JsonConverters::from('DateTime', $o['bookingStartDate']);
        if (isset($o['bookingEndDate'])) $this->bookingEndDate = JsonConverters::from('DateTime', $o['bookingEndDate']);
        if (isset($o['notes'])) $this->notes = $o['notes'];
        if (isset($o['cancelled'])) $this->cancelled = $o['cancelled'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->roomType)) $o['roomType'] = JsonConverters::to('RoomType', $this->roomType);
        if (isset($this->roomNumber)) $o['roomNumber'] = $this->roomNumber;
        if (isset($this->cost)) $o['cost'] = $this->cost;
        if (isset($this->bookingStartDate)) $o['bookingStartDate'] = JsonConverters::to('DateTime', $this->bookingStartDate);
        if (isset($this->bookingEndDate)) $o['bookingEndDate'] = JsonConverters::to('DateTime', $this->bookingEndDate);
        if (isset($this->notes)) $o['notes'] = $this->notes;
        if (isset($this->cancelled)) $o['cancelled'] = $this->cancelled;
        return empty($o) ? new class(){} : $o;
    }
}

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

PATCH /booking/{Id} HTTP/1.1 
Host: vue-vite-api.jamstacks.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBooking xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <BookingEndDate>0001-01-01T00:00:00</BookingEndDate>
  <BookingStartDate>0001-01-01T00:00:00</BookingStartDate>
  <Cancelled>false</Cancelled>
  <Cost>0</Cost>
  <Id>0</Id>
  <Name>String</Name>
  <Notes>String</Notes>
  <RoomNumber>0</RoomNumber>
  <RoomType>Single</RoomType>
</UpdateBooking>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</IdResponse>