| POST | /api/profiles |
|---|
<?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};
/** @description Add a Users Profile information' */
// @Api(Description="Add a Users Profile information'")
class AddUserProfile implements JsonSerializable
{
public function __construct(
/** @var array<string>|null */
public ?array $UserIds=null,
/** @var array<string>|null */
public ?array $ContactIds=null,
/** @var string */
public string $ProfileToShareId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['UserIds'])) $this->UserIds = JsonConverters::fromArray('Guid', $o['UserIds']);
if (isset($o['ContactIds'])) $this->ContactIds = JsonConverters::fromArray('Guid', $o['ContactIds']);
if (isset($o['ProfileToShareId'])) $this->ProfileToShareId = $o['ProfileToShareId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->UserIds)) $o['UserIds'] = JsonConverters::toArray('Guid', $this->UserIds);
if (isset($this->ContactIds)) $o['ContactIds'] = JsonConverters::toArray('Guid', $this->ContactIds);
if (isset($this->ProfileToShareId)) $o['ProfileToShareId'] = $this->ProfileToShareId;
return empty($o) ? new class(){} : $o;
}
}
class AddUserProfileResponse implements JsonSerializable
{
public function __construct(
/** @var array<ResponseError>|null */
public ?array $Errors=null,
/** @description Guid representing the object that is the User Profile Id in Eros. */
// @ApiMember(DataType="Guid", Description="Guid representing the object that is the User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
/** @var string */
public string $ProfileToShareId='',
/** @description Service Stack Response Status. */
// @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Errors'])) $this->Errors = JsonConverters::fromArray('ResponseError', $o['Errors']);
if (isset($o['ProfileToShareId'])) $this->ProfileToShareId = $o['ProfileToShareId'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Errors)) $o['Errors'] = JsonConverters::toArray('ResponseError', $this->Errors);
if (isset($this->ProfileToShareId)) $o['ProfileToShareId'] = $this->ProfileToShareId;
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/profiles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ContactIds>
<ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
<UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</UserIds>
</AddUserProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddUserProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Errors xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</Errors>
<ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
<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>
</AddUserProfileResponse>