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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Update the order of contacts in the specified contact group
    */
    @Api(Description="Update the order of contacts in the specified contact group")
    public static class UpdateContactGroupOrder
    {
        /**
        * Connection of contact to update index in the group
        */
        @ApiMember(Description="Connection of contact to update index in the group", Name="ContactGroupConnectionId")
        public UUID ContactGroupConnectionId = null;

        /**
        * The index of the contact in the group
        */
        @ApiMember(Description="The index of the contact in the group", Name="Index")
        public Integer Index = null;
        
        public UUID getContactGroupConnectionId() { return ContactGroupConnectionId; }
        public UpdateContactGroupOrder setContactGroupConnectionId(UUID value) { this.ContactGroupConnectionId = value; return this; }
        public Integer getIndex() { return Index; }
        public UpdateContactGroupOrder setIndex(Integer value) { this.Index = value; return this; }
    }

    public static class StringResponse
    {
        public String Result = null;
        
        public String getResult() { return Result; }
        public StringResponse setResult(String value) { this.Result = value; return this; }
    }

}

Java 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>