POST | /customers |
---|
<?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;
}
}
/**
* @template ICreateDb of Customers
*/
class CreateChinookCustomer implements IPost, ICreateDb, JsonSerializable
{
public function __construct(
/** @var string */
public string $firstName='',
/** @var string */
public string $lastName='',
/** @var string */
public string $company='',
/** @var string */
public string $address='',
/** @var string */
public string $city='',
/** @var string */
public string $state='',
/** @var string */
public string $country='',
/** @var string */
public string $postalCode='',
/** @var string */
public string $phone='',
/** @var string */
public string $fax='',
/** @var string */
public string $email='',
/** @var int|null */
public ?int $supportRepId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['company'])) $this->company = $o['company'];
if (isset($o['address'])) $this->address = $o['address'];
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['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['phone'])) $this->phone = $o['phone'];
if (isset($o['fax'])) $this->fax = $o['fax'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['supportRepId'])) $this->supportRepId = $o['supportRepId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->company)) $o['company'] = $this->company;
if (isset($this->address)) $o['address'] = $this->address;
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->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->phone)) $o['phone'] = $this->phone;
if (isset($this->fax)) $o['fax'] = $this->fax;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->supportRepId)) $o['supportRepId'] = $this->supportRepId;
return empty($o) ? new class(){} : $o;
}
}
PHP CreateChinookCustomer DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers HTTP/1.1
Host: blazor-gallery.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateChinookCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Chinook.ServiceModel">
<Address>String</Address>
<City>String</City>
<Company>String</Company>
<Country>String</Country>
<Email>String</Email>
<Fax>String</Fax>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Phone>String</Phone>
<PostalCode>String</PostalCode>
<State>String</State>
<SupportRepId>0</SupportRepId>
</CreateChinookCustomer>
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>