Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Archives or Restores a Role Group record.
    */
    @Api(Description="Archives or Restores a Role Group record.")
    public static class UpdateRoleGroupStatus
    {
        /**
        * 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")
        public UUID ContactRoleGroupId = null;

        /**
        * 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")
        public Boolean IsActionArchive = null;
        
        public UUID getContactRoleGroupId() { return ContactRoleGroupId; }
        public UpdateRoleGroupStatus setContactRoleGroupId(UUID value) { this.ContactRoleGroupId = value; return this; }
        public Boolean getIsActionArchive() { return IsActionArchive; }
        public UpdateRoleGroupStatus setIsActionArchive(Boolean value) { this.IsActionArchive = value; return this; }
    }

}

Java UpdateRoleGroupStatus DTOs

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

{
	IsActionArchive: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}