Updates Program Season Registration Forms webhook

05 April 2023 10:11

The following changes are scheduled to be released by PlayHQ on the 1st of May 2023.

Updated events:

Created (PROGRAM_SEASON_REGISTRATION_FORM.CREATED)
Updated (PROGRAM_SEASON_REGISTRATION_FORM.UPDATED)

The Program Season Registration Forms webhook is updated to support group fee variants:

A new Fee Type is added: ‘Group’
A Group Id field is added to the Fee structure

See changes in table below, highlighted in green

Field Name	Field Label	Field Description	Sample	Type	IsNullable	Comments / Questions
id	Id	Registration settings Id		UUID	No
programId	Program Id	Program Id that settings belong to (via Season)		UUID	No
seasonId	Season Id	Season Id that settings belong to		UUID	No
organisationId	Registration settings owner Id	Organisation Id that settings belongs to		UUID	No
startDateTime	Registration start date/time	Start date/time assigned to registration		Date/time	No	this date/time is presented in UTC format and will be provided in the organisation’s timezone
endDateTime	Registration end date/time	End date/time assigned to registration		Date/time	No	this date/time is presented in UTC format and will be provided in the organisation’s timezone
formUrl	Registration form url	Unique URL for the registration form		String	No
visible	Registration form visibility	Flags whether or not Registration form should be visible on PlayHQ.com		Boolean	No
format	Program Format	Format of program as specified by admin during program creation	Junior Blasters	String (no limit but defined picklist)	No
ageRestrictions		Object of all sub-arrays (defined below) Specific age range(s) for participants to register to the program. Participants who do not meet this criteria will be unable to register.
ageRestrictions.calculateAgeOfPlayerAsAtDate	Calculate Age Of Player As At Date	Specific date used to calculate players age as of this date.		Date	Yes
ageRestrictions.ageFrom	Age from	Starting age limit player will be allowed to register	5	Integer	Yes
ageRestrictions.ageTo	Age to	Ending age limit player will be allowed to register	10	Integer	Yes
fee		Object of all sub-arrays (defined below)			Yes	Fees will appear where available else null
fee.type	Fee Type	Type of fee applied i.e. Base, Advanced, or Group	Base, Advanced, Group	String	No	Can be ‘Base’, 'Advanced' or ‘Group’
fee.orgId	Org ID	Field to determine which organisation created the fee i.e. Competition owning or participating organisation		UUID	No	This can be owning org (admin body) and participating org
fee.role	Role	Participant role fee is applied too	Player, Volunteer, Official, Team Manager	String	No
fee.amount	Fee Amount	Fee amount applied	$20.00	Currency	No	At least 1 “Fee” field needs to be populated on the registration settings
fee.description	Fee Description	Description of fee, applied by admin during registration form creation	Group 1	String (no limit)	No
fee.ageAsAtDate	Calculate Age Of Player As At Date	Date limit for calculating advanced player age fee (where applicable)		Date	Yes	Only relevant to advanced player fees For a base fee this field will be null
fees.ageMin	Age Min	Minimum age limit	5	Integer	Yes	Only relevant to advanced player fees For a base fee this field will be null
fees.ageMax	Age Max	Maximum age limit	10	Integer	Yes	Only relevant to advanced player fees For a base fee this field will be null
fees.gender	Gender	Gender	Male, Female, All	String	Yes	Only relevant to advanced player fees For a base fee this field will be null
fees.groupId	Group Id	Group Id for the group fee variant		UUID	Yes	Only populated if Fee Type is ‘Group’

Example using the updated Fee structure:

{
  "messageId": "010f7261-b2f3-43dc-9e76-8186afe7768b",
  "eventType": "PROGRAM_SEASON_REGISTRATION_FORM.CREATED",
  "entityId": "a3a71562-d598-4136-9790-2802d8526055",
  "eventRaisedDateTime": "2021-03-23T00:05:38.893Z",
  "data": {
    "id": "a3a71562-d598-4136-9790-2802d8526055",
    "eventRaisedDateTime": "2021-03-23T00:05:38.893Z",
    "programId": "05e7bda6-779a-4bf8-84fb-d8500a69c90f",
    "seasonId": "fef71293-ec58-4999-84b0-480e205c6dba",
    "organisationId": "d3676408-62b9-475e-b504-705f4d8e3003",
    "startDateTime": "2021-03-06T04:00:00.000Z",
    "endDateTime": "2021-03-13T12:00:00.000Z",
    "formUrl": "https://www.wizards.playhq.com/afl/register/4182ef",
    "visible": false
    "agerestrictions" : {
          "calculateAgeOfPlayerAsAtDate" : "date",
          "agefrom" : 5,
          "ageto" : 10 },
    "fee": [
    { 
      "type" : "Base",
      "orgId" : "8581fcf6-d376-457b-8e06-7475b834b54a",
      "role" : "PLAYER",
      "amount" : 20,
      "description" : "Player Fee"}
    { 
      "type" : "Base",
      "orgId" : "d3676408-62b9-475e-b504-705f4d8e3003",
      "role" : "PLAYER",
      "amount" : 40,
      "description" : "Player Fee"}
    { 
      "type" : "Base",
      "orgId" : "d3676408-62b9-475e-b504-705f4d8e3003",
      "role" : "VOLUNTEER",
      "amount" : 30,
      "description" : "Volunteer Fee"}
    { 
      "type" : "Group",
      "orgId" : "d3676408-62b9-475e-b504-705f4d8e3003",
      "role" : "PLAYER",
      "amount" : 35,
      "description" : "Group 1",
      "groupId": "17752178-622f-4037-91e9-d7c045875925"}
    { 
      "type" : "Group",
      "orgId" : "d3676408-62b9-475e-b504-705f4d8e3003",
      "role" : "PLAYER",
      "amount" : 30,
      "description" : "Group 2",
      "groupId": "96f7b7e8-26a6-4826-99b4-fe40e96038ea"}
      ]
  }
}

Was this article helpful?

0 out of 0 found this helpful

Updates Program Season Registration Forms webhook

Articles in this section