Close
    logoPlayHQ Webhook Documentation

    Organisations

    Last update: 18 minutes ago by Nazar32Reading time: 2 min

    Data to be included in file

    Field Name in FileField DescriptionSample DataField TypeSizeIsNullableComments
    idOrganisation's UUID88a5b302-f71f-11ea-adc1-0242ac120002UUIDNoThis ID is unique to each organisation
    nameName of the OrganisationRowville Cricket ClubString60NoThe Organisation Name, in conjunction with the Organisation Type, would effectively replace the current 2 column approach in the registrations file as described further in the cell below
    typeType of the Organisationpicklist:
    • ADMINISTRATIVE_BODY
    • ASSOCIATION
    • CLUB
    String (will be one of the three values specified)No
    • “State”-level organisations will always have an Organisation Type = “Administrative Body”
    • States are not identified in any way that differentiates them from other regional Administrative Bodies (or National, for that matter)
    parentOrganisationIdDirect Parent of the Organisation88a5b302-f71f-11ea-adc1-0242ac120002UUIDYes
    • Only the tenant org will not have a parent organisation
    • Only organisations with an organisation type of “Administrative Body” can be Parent Organisations
    • The Parent Organisation can be used to populate the “Region” field to replicate the data in the current registrations file by finding the direct parent of the organisation that the participant registered to
    • If multiple layers sit between the State and Centre e.g. regions and sub-regions, these details can be pieced together with the info provided in this file
    emailContact email address listed on the Organisationinfo@rowvillecc.org.auStringNo
    urlURL listed for the Organisationhttp://www.rowvillecc.org.au/StringYes
    contactNumberCountryCodeCountry prefix for the contact phone number listed on the Organisation61String (limited to 3 chars eg +61)Yes
    • We seperate country code out
    • At the moment, this will only ever be "61" for Australia
    contactNumberContact Phone Number listed on the Organisation422222222StringYes
    taxStatusTax status of the Organisationpicklist:
    • NO_TAX
    • AUS_GST
    String (limited to one of the options listed)No
    addressAddress listed on the Organisation123 StreetStringYes
    suburbSuburb listed on the OrganisationRowvilleStringYes
    postcodePostcode listed on the Organisation3178StringYes
    stateState listed on the OrganisationVIC, NSW, ACT, QLD, TAS, NT, SA, WAString (limited to one of the options listed)Yes
    countryCountry listed on the OrganisationAustraliaString (Will always be Australia at the moment)Yes
    createdAtDate/time the Organisation was created2020-08-27T06:29:54.400000000ZStringNo
    • String is an ISO 8601 DateTime in UTC timezone
    updatedAtDate/time the Organisation was last updated2020-08-27T06:29:54.400000000ZStringNo
    • String is an ISO 8601 DateTime in UTC timezone
    • populated with the most recent value after considering the updated at field on the Org node, the created at field on the Org’s relationship to Address, and the created at field on the Org’s relationship to parent
    orgDefaultTimeZoneDefault time zone of the organisationAustralia/MelbourneString (limited to one of the options listed)No
    orgDescriptionDescription listed for the org on the My Organisation > Overview pageOur organisation offers the following ways to play…StringYes
    includeInFinderVisible on discovery maps settingtrueBooleanNo
    visibleOrganisation visibility setting for PlayHQtrueBooleanNo
    latitudeLatitude of the Organisation-37.87639StringYes
    longitudeLongitude of the Organisation-73.87639StringYes
    Data Warehouse Integration Solution — Previous
    Merchandise Orders
    Next — Data Warehouse Integration Solution
    Playing Surfaces