Platform API

AddContactRoleGroup

Create new contact role group

The following routes are available for this service:
POST	/api/contactrolegroups

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

public class dtos
{

    /**
    * Create new contact role group
    */
    @Api(Description="Create new contact role group")
    public static class AddContactRoleGroup
    {
        /**
        * Contact role group name to be created
        */
        @ApiMember(Description="Contact role group name to be created", Name="Name")
        public String Name = null;

        public ArrayList<ListItemModel> Roles = null;
        
        public String getName() { return Name; }
        public AddContactRoleGroup setName(String value) { this.Name = value; return this; }
        public ArrayList<ListItemModel> getRoles() { return Roles; }
        public AddContactRoleGroup setRoles(ArrayList<ListItemModel> value) { this.Roles = value; return this; }
    }

    public static class ListItemModel
    {
        public UUID ListItemId = null;
        public String Name = null;
        public String Description = null;
        public String ShortName = null;
        public Boolean IsDefault = null;
        public Integer Order = null;
        public UUID ListItemTrafficLightId = null;
        public UUID PrimaryListItemImageId = null;
        public String PrimaryListItemImageUrl = null;
        public String PrimaryImageThumbnailUrl = null;
        public UUID OwnerContactId = null;
        public String RecordStatus = null;
        
        public UUID getListItemId() { return ListItemId; }
        public ListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public String getName() { return Name; }
        public ListItemModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ListItemModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public ListItemModel setShortName(String value) { this.ShortName = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public ListItemModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Integer getOrder() { return Order; }
        public ListItemModel setOrder(Integer value) { this.Order = value; return this; }
        public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
        public ListItemModel setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
        public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
        public ListItemModel setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
        public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
        public ListItemModel setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
        public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
        public ListItemModel setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ListItemModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ListItemModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

    @ApiResponse(Description="Create contact role group")
    public static class AddContactRoleGroupResponse
    {
        public UUID ContactRoleGroupId = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getContactRoleGroupId() { return ContactRoleGroupId; }
        public AddContactRoleGroupResponse setContactRoleGroupId(UUID value) { this.ContactRoleGroupId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AddContactRoleGroupResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java AddContactRoleGroup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Name":"String","Roles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}