Platform API

AddContactRole

Add a custom role for the licensee

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

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

public class dtos
{

    /**
    * Add a custom role for the licensee
    */
    @Api(Description="Add a custom role for the licensee")
    public static class AddContactRole
    {
        /**
        * Details of the Contact Role to be Added.
        */
        @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")
        public RoleDetailsModel RoleDetails = null;
        
        public RoleDetailsModel getRoleDetails() { return RoleDetails; }
        public AddContactRole setRoleDetails(RoleDetailsModel value) { this.RoleDetails = value; return this; }
    }

    public static class RoleDetailsModel
    {
        /**
        * Role Id
        */
        @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
        public UUID RoleId = null;

        /**
        * Role Name
        */
        @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
        public String RoleName = null;

        /**
        * Role Connection Definition Id
        */
        @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
        public UUID RoleConnectionDefinitionId = null;

        /**
        * Contact Types the Role applies to
        */
        @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
        public ArrayList<UUID> ContactTypes = null;

        /**
        * Does the role require contacts to accept it?
        */
        @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
        public Boolean RequireContactsToAccept = null;

        /**
        * Filters linked to the custom role.
        */
        @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
        public ArrayList<ListItemFilterModel> ListItemFilters = null;
        
        public UUID getRoleId() { return RoleId; }
        public RoleDetailsModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public RoleDetailsModel setRoleName(String value) { this.RoleName = value; return this; }
        public UUID getRoleConnectionDefinitionId() { return RoleConnectionDefinitionId; }
        public RoleDetailsModel setRoleConnectionDefinitionId(UUID value) { this.RoleConnectionDefinitionId = value; return this; }
        public ArrayList<UUID> getContactTypes() { return ContactTypes; }
        public RoleDetailsModel setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
        public Boolean isRequireContactsToAccept() { return RequireContactsToAccept; }
        public RoleDetailsModel setRequireContactsToAccept(Boolean value) { this.RequireContactsToAccept = value; return this; }
        public ArrayList<ListItemFilterModel> getListItemFilters() { return ListItemFilters; }
        public RoleDetailsModel setListItemFilters(ArrayList<ListItemFilterModel> value) { this.ListItemFilters = value; return this; }
    }

    public static class ListItemFilterModel
    {
        public UUID ListItemFilterId = null;
        public String FilterName = null;
        public UUID ListId = null;
        public UUID ListItemId = null;
        public Boolean ListItemIsInFilter = null;
        
        public UUID getListItemFilterId() { return ListItemFilterId; }
        public ListItemFilterModel setListItemFilterId(UUID value) { this.ListItemFilterId = value; return this; }
        public String getFilterName() { return FilterName; }
        public ListItemFilterModel setFilterName(String value) { this.FilterName = value; return this; }
        public UUID getListId() { return ListId; }
        public ListItemFilterModel setListId(UUID value) { this.ListId = value; return this; }
        public UUID getListItemId() { return ListItemId; }
        public ListItemFilterModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public Boolean isListItemIsInFilter() { return ListItemIsInFilter; }
        public ListItemFilterModel setListItemIsInFilter(Boolean value) { this.ListItemIsInFilter = value; return this; }
    }

}

Java AddContactRole 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.

POST /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RoleDetails":{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleConnectionDefinitionId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"RequireContactsToAccept":false,"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":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"}}