PlayHQ External API (1.0.0)

Download OpenAPI specification:Download

API Support: support@playhq.com URL: http://playhq.com/ License: Apache 2.0 Terms of Service

External API to exposing with playhq services.

Organisations

Lists all organisations

Please note, this API is deprecated and will be decommissioned in the near future.

query Parameters

page	number [ 0 .. totalPages in response metadata ] Default: 1 Page Number to fetch data
limit	number [ 1 .. 100 ] Default: 10 Number of objects per page to return
changedSince	string Date in ISO 8601 format to fetch updates since
type	string One of CLUB, ASSOCIATION, ADMINISTRATIVE_BODY or ALL. Defaults to ALL

header Parameters

Authorization

required

string

Bearer {JWT_Auth_Token}

Responses

Response samples

200
4XX, 5XX

Content type

application/json

{"data": {"organisations": [{"id": "859d858a-6804-4848-ba4e-fc1105baab43",
"name": "SY MS AFL Club",
"nickname": "SYs",
"logoName": "https://assets.playhq.com/59d858/128_128_logo.png",
"termsAndConditionsUrl": "",
"type": "CLUB",
"taxStatus": "AUS_GST",
"visible": true,
"routingCode": "859d858a",
"createdAt": "2020-08-19T05:09:46.408000000Z",
"updatedAt": "2020-09-08T23:04:13.098000000Z",
"address": {"line1": "Apt 5, example street",
"suburb": "fitzroy",
"postcode": "3605",
"state": "VIC",
"country": "Australia"
},
"contact": {"contactName": "",
"contactNumber": "+611234567",
"telCountryCode": "61",
"email": "test@playhq.com",
"websiteUrl": "http://www.example.com"
}
}
]
},
"metadata": {"page": 4,
"totalPages": 36,
"totalRecords": 355
}
}

Organisation Created Webhook

Information about a new organisation

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "ORGANISATION.CREATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "string",
"entityId": "string",
"eventRaisedDateTime": "string",
"eventType": "ORGANISATION.CREATED",
"data": {"id": "string",
"eventRaisedDateTime": "string",
"parentId": "string",
"name": "string",
"type": "ADMINISTRATIVE_BODY",
"timezone": "string",
"visible": true,
"logo": {"url": "string",
"dimensions": {"width": "string",
"height": "string"
}
},
"description": "string",
"email": "string",
"contactNumber": "string",
"telCountryCode": "string",
"websiteUrl": "string",
"includeInFinder": true,
"formats": [{"type": "COMPETITION",
"format": "string"
}
],
"demographics": [{"ageFrom": 0,
"ageTo": 0,
"gender": "string"
}
],
"address": {"line1": "string",
"suburb": "string",
"state": "string",
"postcode": "string",
"country": "string",
"latitude": "string",
"longitude": "string"
},
"inclusions": ["string"
],
"contacts": [{"id": "string",
"organisationId": "string",
"firstName": "string",
"lastName": "string",
"position": "string",
"email": "string",
"phone": "string",
"visible": true,
"sequenceNo": 0
}
]
}
}

Organisation Updated Webhook

Information about an existing organisation which has been updated

header Parameters

signature

string

Example: c39b429c743877c0c2954800d431713741e6ddd2cfb2f103d431b3c02290a82a

Signature formed using SHA-256 hex encoding of request body and sent with respective webhook for verification purpose

Request Body schema: application/json

messageId	string The unique identifier for the event message
entityId	string The unique identifier for the record
eventRaisedDateTime	string The time the event occurred, as an ISO 8601 string
eventType	string Value: "ORGANISATION.UPDATED"
	object

Responses

Request samples

Payload

Content type

application/json

{"messageId": "string",
"entityId": "string",
"eventRaisedDateTime": "string",
"eventType": "ORGANISATION.UPDATED",
"data": {"id": "string",
"eventRaisedDateTime": "string",
"parentId": "string",
"name": "string",
"type": "ADMINISTRATIVE_BODY",
"timezone": "string",
"visible": true,
"logo": {"url": "string",
"dimensions": {"width": "string",
"height": "string"
}
},
"description": "string",
"email": "string",
"contactNumber": "string",
"telCountryCode": "string",
"websiteUrl": "string",
"includeInFinder": true,
"formats": [{"type": "COMPETITION",
"format": "string"
}
],
"demographics": [{"ageFrom": 0,
"ageTo": 0,
"gender": "string"
}
],
"address": {"line1": "string",
"suburb": "string",
"state": "string",
"postcode": "string",
"country": "string",
"latitude": "string",
"longitude": "string"
},
"inclusions": ["string"
],
"contacts": [{"id": "string",
"organisationId": "string",
"firstName": "string",
"lastName": "string",
"position": "string"