Platform API

AddContactRole

Add a custom role for the licensee

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


export class ListItemFilterModel
{
    public ListItemFilterId: string;
    public FilterName: string;
    public ListId: string;
    public ListItemId: string;
    public ListItemIsInFilter: boolean;

    public constructor(init?: Partial<ListItemFilterModel>) { (Object as any).assign(this, init); }
}

export class RoleDetailsModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public RoleId: string;

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

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

    /** @description Contact Types the Role applies to */
    // @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    public ContactTypes: string[];

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

    /** @description Filters linked to the custom role. */
    // @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    public ListItemFilters: ListItemFilterModel[];

    public constructor(init?: Partial<RoleDetailsModel>) { (Object as any).assign(this, init); }
}

/** @description Add a custom role for the licensee */
// @Api(Description="Add a custom role for the licensee")
export class AddContactRole
{
    /** @description 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 RoleDetails: RoleDetailsModel;

    public constructor(init?: Partial<AddContactRole>) { (Object as any).assign(this, init); }
}

TypeScript AddContactRole DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	RoleDetails: 
	{
		RoleName: String,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		RequireContactsToAccept: False,
		ListItemFilters: 
		[
			{
				FilterName: String,
				ListItemIsInFilter: 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
	}
}