| PUT | /api/contactgroup/{ContactGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactgroup/{ContactGroupId}/restore |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Archives or Restores a Contact Group record.
*/
@Api(Description="Archives or Restores a Contact Group record.")
public static class UpdateContactGroupStatus
{
/**
* ContactGroupId of the Contact group to be deleted
*/
@ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")
public UUID ContactGroupId = 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 getContactGroupId() { return ContactGroupId; }
public UpdateContactGroupStatus setContactGroupId(UUID value) { this.ContactGroupId = value; return this; }
public Boolean getIsActionArchive() { return IsActionArchive; }
public UpdateContactGroupStatus setIsActionArchive(Boolean value) { this.IsActionArchive = value; return this; }
}
}
Java UpdateContactGroupStatus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contactgroup/{ContactGroupId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ContactGroupId":"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"}}