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
import 'package:servicestack/servicestack.dart';

class StringResponse implements IConvertible
{
    String? Result;

    StringResponse({this.Result});
    StringResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Result = json['Result'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Result': Result
    };

    getTypeName() => "StringResponse";
    TypeContext? context = _ctx;
}

/**
* 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 IConvertible
{
    /**
    * Connection of contact to update index in the group
    */
    // @ApiMember(Description="Connection of contact to update index in the group", Name="ContactGroupConnectionId")
    String? ContactGroupConnectionId;

    /**
    * The index of the contact in the group
    */
    // @ApiMember(Description="The index of the contact in the group", Name="Index")
    int? Index;

    UpdateContactGroupOrder({this.ContactGroupConnectionId,this.Index});
    UpdateContactGroupOrder.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactGroupConnectionId = json['ContactGroupConnectionId'];
        Index = json['Index'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactGroupConnectionId': ContactGroupConnectionId,
        'Index': Index
    };

    getTypeName() => "UpdateContactGroupOrder";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'UpdateContactGroupOrder': TypeInfo(TypeOf.Class, create:() => UpdateContactGroupOrder()),
});

Dart UpdateContactGroupOrder DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateContactGroupOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactGroupConnectionId>00000000-0000-0000-0000-000000000000</ContactGroupConnectionId>
  <Index>0</Index>
</UpdateContactGroupOrder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StringResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
  <Result>String</Result>
</StringResponse>