Platform API

AddContactRoleGroup

Create new contact role group

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


// @ApiResponse(Description="Create contact role group")
export class AddContactRoleGroupResponse
{
    public ContactRoleGroupId: string;
    public ResponseStatus: ResponseStatus;

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

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 Create new contact role group */
// @Api(Description="Create new contact role group")
export class AddContactRoleGroup
{
    /** @description Contact role group name to be created */
    // @ApiMember(Description="Contact role group name to be created", Name="Name")
    public Name: string;

    public Roles: ListItemModel[];

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

TypeScript AddContactRoleGroup 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/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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}