metageo-social-api

0.0.1 • Public • Published

metageo-social-api Build Status

provides the social event API social events are planned events that will happen in the future (in most cases). Most often when you are sharing an event that is being planned the purpose of sharing is so that other people can participate in that event and therefore they are "social" events.

Installation

Inside your metageo directory run npm install git+https://github.com/craveprogramminginc/metageo-social-api Then add it to you configuration file under plugins

plugins:
  metageo-social-api: {}

API End Points

POST: api/event/social

Create a social event. Requires Authentication.

GET: api/event/social/<id>

Retrieves a social event.

PUT: api/event/social/<id>

Updates a social event. Requires Authentication.

DELETE: api/event/social/<id>

Deletes a social event. Requires Authentication.

Schema

Social Event

Parameter Format Description
id string
title required string
start required ISO 8601 when the event begins
end ISO 8601 when the event ends
actor string the ID of the user who created this event
content required string
address string
collections string
lat required if not using geojson cooridate the latitude of the event
lng required if not using geojson cooridate the longitude of the event
geometry required if not using lat, lng cooridnate pairs geoJSON the location of the event
objectType "social" (string) what type of event is this
published ISO 8601 when was the event

Readme

Keywords

Package Sidebar

Install

npm i metageo-social-api

Weekly Downloads

0

Version

0.0.1

License

AGPL

Last publish

Collaborators

  • null_radix