Platform API

<back to all web services

UpdateContactGroupOrder

Update the order of contacts in the specified contact group

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactgroups/updatecontactgrouporder
<?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 StringResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Result=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Result'])) $this->Result = $o['Result'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Result)) $o['Result'] = $this->Result;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Update the order of contacts in the specified contact group */
// @Api(Description="Update the order of contacts in the specified contact group")
class UpdateContactGroupOrder implements JsonSerializable
{
    public function __construct(
        /** @description Connection of contact to update index in the group */
        // @ApiMember(Description="Connection of contact to update index in the group", Name="ContactGroupConnectionId")
        /** @var string */
        public string $ContactGroupConnectionId='',

        /** @description The index of the contact in the group */
        // @ApiMember(Description="The index of the contact in the group", Name="Index")
        /** @var int */
        public int $Index=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ContactGroupConnectionId'])) $this->ContactGroupConnectionId = $o['ContactGroupConnectionId'];
        if (isset($o['Index'])) $this->Index = $o['Index'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ContactGroupConnectionId)) $o['ContactGroupConnectionId'] = $this->ContactGroupConnectionId;
        if (isset($this->Index)) $o['Index'] = $this->Index;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateContactGroupOrder DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

POST /api/contactgroups/updatecontactgrouporder HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactGroupConnectionId":"00000000-0000-0000-0000-000000000000","Index":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Result":"String"}