Platform API

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

The following routes are available for this service:
PUT	/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT	/api/contactrolegroup/{ContactRoleGroupId}/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 Role Group record. */
// @Api(Description="Archives or Restores a Role Group record.")
class UpdateRoleGroupStatus implements JsonSerializable
{
    public function __construct(
        /** @description Id of the Contact Role Group record to be Archived or Restored. */
        // @ApiMember(DataType="Guid", Description="Id of the Contact Role Group record to be Archived or Restored.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
        /** @var string */
        public string $ContactRoleGroupId='',

        /** @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['ContactRoleGroupId'])) $this->ContactRoleGroupId = $o['ContactRoleGroupId'];
        if (isset($o['IsActionArchive'])) $this->IsActionArchive = $o['IsActionArchive'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ContactRoleGroupId)) $o['ContactRoleGroupId'] = $this->ContactRoleGroupId;
        if (isset($this->IsActionArchive)) $o['IsActionArchive'] = $this->IsActionArchive;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateRoleGroupStatus 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactRoleGroupId":"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"}}