Api to communicate with VMS¶
The purpose of building this API was to provide information about the meetups in Portal to VMS so that their volunteers could participate in them. Presently, there are three fields of meetups which are sent to VMS via the API:
- Event Name - Title of the event going to be held.
- Start Date - The date from which the event would start.
- End Date - The date on which the event would end.
- Description - The description of the event.
- Meetup Id - The unique Id of the meetup.
- Venue - The location of the event.
Users can send in a GET
or a POST
request to https://localhost/meetup/api/v1/request_meetup_data/ to access the meetup data.
In case of a GET
request, a list containing the details of all meetups
in the ascending order of their dates will be returned :
In case of a POST
request,a list containing the details of all meetups
occurring after the ID value sent in the request object will be returned :
Details of the API¶
Use Case : Send event details for volunteers to contribute accordingly.
API Method : GET/POST
URL Parameters :
https://localhost/meetup/api/v1/request_meetup_data/
Request Body:
{ "Meetup-Id” : “id after which all meetups are required” }
Response Body - Success:
{ "" “Event Name/Title” : “ --------” “Start Date” : “-----------” "End Date" : "-------------" "Description" : "----------" "Meetup Id" : "-------------" “Venue” : “------------------” }
Response Body - Error:
{ "message": "Please send a proper request" }