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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class StringResponse
    {
        public virtual string Result { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Update the order of contacts in the specified contact group
    ///</summary>
    [Api(Description="Update the order of contacts in the specified contact group")]
    public partial class UpdateContactGroupOrder
    {
        ///<summary>
        ///Connection of contact to update index in the group
        ///</summary>
        [ApiMember(Description="Connection of contact to update index in the group", Name="ContactGroupConnectionId")]
        public virtual Guid ContactGroupConnectionId { get; set; }

        ///<summary>
        ///The index of the contact in the group
        ///</summary>
        [ApiMember(Description="The index of the contact in the group", Name="Index")]
        public virtual int Index { get; set; }
    }

}

C# 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>