Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT/api/contactrolegroup/{ContactRoleGroupId}/restore
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

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.

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

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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