| PUT | /api/contact/{ContactId}/updatenotifications |
|---|
<?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 NotificationItem implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string|null */
public ?string $Name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
return empty($o) ? new class(){} : $o;
}
}
/** @description Updates contact notifications */
// @Api(Description="Updates contact notifications")
class UpdateContactNotifications implements JsonSerializable
{
public function __construct(
/** @description Id of contact to get notification for */
// @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
/** @var string */
public string $ContactId='',
/** @description Id of licensee to get notification for */
// @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
/** @var string */
public string $LicenseeId='',
/** @description Id of suite to get notification for */
// @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
/** @var string */
public string $SuiteId='',
/** @description List of notification to update */
// @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
/** @var array<NotificationItem>|null */
public ?array $Notifications=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
if (isset($o['LicenseeId'])) $this->LicenseeId = $o['LicenseeId'];
if (isset($o['SuiteId'])) $this->SuiteId = $o['SuiteId'];
if (isset($o['Notifications'])) $this->Notifications = JsonConverters::fromArray('NotificationItem', $o['Notifications']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
if (isset($this->LicenseeId)) $o['LicenseeId'] = $this->LicenseeId;
if (isset($this->SuiteId)) $o['SuiteId'] = $this->SuiteId;
if (isset($this->Notifications)) $o['Notifications'] = JsonConverters::toArray('NotificationItem', $this->Notifications);
return empty($o) ? new class(){} : $o;
}
}
PHP UpdateContactNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contact/{ContactId}/updatenotifications HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000","Notifications":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}