PlaceCal Handbook
  • Introduction
  • How to
    • Log in to PlaceCal
    • Add a Partner
    • Configure a Partner
    • Add a User
    • Add a Calendar
    • Add a Site
    • Configure a Site
    • Add a Tag (Partnership)
  • Reference
    • Supported Calendar sources
      • JSON-LD (generic)
      • iCal (generic)
      • Airtable
      • Dice.fm
      • Eventbrite
      • Google Calendar
      • iCloud Calendar
      • Meetup
      • Outlook 365
      • OutSavvy
      • Resident Advisor (RA)
      • Squarespace
      • Ticketsolve
    • Glossary
      • Calendars
      • Districts
      • Events
      • Neighbourhoods
      • Organisers
      • Partners
      • Partnerships
      • User roles
        • Neighbourhood admins
        • Partner admins
        • Partnership admins
        • Root
        • Site admins
      • Wards
      • Sites
  • Explanation
    • Community Technology Partnerships
    • Structured and unstructured data
    • Resisting walled gardens and big tech silos
  • PlaceCal API
    • Getting started
    • Data structures
    • Making queries
    • Ping
    • Events
    • Partners
Powered by GitBook
On this page
Export as PDF
  1. PlaceCal API

Data structures

Either specified by the query with these fields or returned from the server in this structure

PingType: String


NeighbourhoodType {
  name: String
  abbreviatedName: String
  unit: String
  unitName: String
  unitCodeKey: String
  unitCodeValue: String
}

ContactType {
  name: String
  email: String
  telephone: String
}

OpeningHoursType {
  dayOfWeek: String
  opens: String
  closes: String
}

AddressType {
  streetAddress: String
  postalCode: String
  addressLocality: String
  addressRegion: String
  neighbourhood: NeighbourhoodType
}

PartnerType {
  id: ID
  name: String
  summary: String
  description: String
  accessibilitySummary: String
  logo: String
  url: String
  facebookUrl: String
  twitterUrl: String
  address: AddressType
  areasServed: [NeighbourhoodType]
  contact: ContactType
  openingHours: OpeningHoursType
	articles: [Article]
}

EventType {
  id: ID
  name: String
  summary: String
  description: String
  startDate: ISO88601Format
  endDate: ISO88601Format
  address: AddressType
  organizer: PartnerType
}

ArticleType {
  name: String
  headline: String
  text: String
  articleBody: String
  datePublished: ISO88601Format
  dateCreated: ISO88601Format
  dateUpdated: ISO88601Format
  providers: [Partners]
}
PreviousGetting startedNextMaking queries

Last updated 11 months ago