Platform API

UpdateContactRoleGroup

Update contact role group

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


export class ListItemModel
{
    public ListItemId: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;

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

/** @description Update contact role group */
// @Api(Description="Update contact role group")
export class UpdateContactRoleGroup
{
    /** @description Guid of the Contact Role Group to be updated. */
    // @ApiMember(DataType="Guid", Description="Guid of the Contact Role Group to be updated.", IsRequired=true, Name="RoleGroupId", ParameterType="query")
    public RoleGroupId: string;

    /** @description Contact role group name to be updated */
    // @ApiMember(DataType="string", Description="Contact role group name to be updated", IsRequired=true, Name="Name", ParameterType="query")
    public Name: string;

    public Roles: ListItemModel[];

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

TypeScript UpdateContactRoleGroup 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.

PUT /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Roles: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String
		}
	]
}

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
	}
}