| PUT | /api/contactgroup/{ContactGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactgroup/{ContactGroupId}/restore |
<?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 Archives or Restores a Contact Group record. */
// @Api(Description="Archives or Restores a Contact Group record.")
class UpdateContactGroupStatus implements JsonSerializable
{
public function __construct(
/** @description ContactGroupId of the Contact group to be deleted */
// @ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")
/** @var string */
public string $ContactGroupId='',
/** @description True if the action is Archive, False for Restore. */
// @ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")
/** @var bool|null */
public ?bool $IsActionArchive=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContactGroupId'])) $this->ContactGroupId = $o['ContactGroupId'];
if (isset($o['IsActionArchive'])) $this->IsActionArchive = $o['IsActionArchive'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContactGroupId)) $o['ContactGroupId'] = $this->ContactGroupId;
if (isset($this->IsActionArchive)) $o['IsActionArchive'] = $this->IsActionArchive;
return empty($o) ? new class(){} : $o;
}
}
PHP UpdateContactGroupStatus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contactgroup/{ContactGroupId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ContactGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}