APIs designed to simplify managing event volunteers by handling registrations, schedules, & roles. Ideal for organizing events efficiently and ensuring seamless coordination with volunteers.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29778371","collectionId":"f8e55e5b-1697-4290-9021-5b560ec82fa8","publishedId":"2sAYBbfA2g","public":true,"customColor":{"top-bar":"525FE1","right-sidebar":"FFA41B","highlight":"FF6C37"},"publishDate":"2025-01-04T13:23:01.000Z"},"item":[{"name":"Home","id":"74ec0fd6-7e62-4ae0-9fdf-a59ea76c7ec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host-events}}/","urlObject":{"path":[""],"host":["{{host-events}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74ec0fd6-7e62-4ae0-9fdf-a59ea76c7ec7"},{"name":"Get events","id":"680021b0-7ee1-452d-9df1-28faf6ffc2f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host-events}}/events","description":"The endpoint retrieves a list of events. The response for this request can be represented as a JSON schema as follows:
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"_id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"date\": { \"type\": \"string\" },\n \"location\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"requiredVolunteers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"roleName\": { \"type\": \"string\" },\n \"roleRequirements\": { \"type\": \"string\" },\n \"requiredNumber\": { \"type\": \"integer\" },\n \"_id\": { \"type\": \"string\" }\n }\n }\n },\n \"registeredVolunteers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"volunteer\": { \"type\": \"string\" },\n \"role\": { \"type\": \"string\" },\n \"_id\": { \"type\": \"string\" }\n }\n }\n },\n \"__v\": { \"type\": \"integer\" }\n }\n }\n}\n\nThis endpoint is used to update the details of a specific event.
\nname (string, required): The name of the event.
\ndate (string, required): The date of the event.
\nlocation (string, required): The location of the event.
\ndescription (string, required): A brief description of the event.
\ntype (string, required): The type of the event.
\nrequiredVolunteers (array, required): An array of objects containing details about the volunteers required for the event.
\nroleName (string, required): The role or position for which volunteers are required.
\nroleRequirements (string, required): The specific requirements or responsibilities for the role.
\nrequiredNumber (number, required): The number of volunteers required for the role.
\nThe response will be in the form of a JSON schema with the following properties:
\n_id (string): The unique identifier of the event.
\nname (string): The name of the event.
\ndate (string): The date of the event.
\nlocation (string): The location of the event.
\ndescription (string): A brief description of the event.
\ntype (string): The type of the event.
\nrequiredVolunteers (array): An array of objects containing details about the required volunteers.
\nroleName (string): The role or position for which volunteers are required.
\nroleRequirements (string): The specific requirements or responsibilities for the role.
\nrequiredNumber (number): The number of volunteers required for the role.
\nregisteredVolunteers (array): An array of objects containing details about the volunteers who have registered for the event.
\nvolunteer (string): The name of the volunteer.
\nrole (string): The role or position for which the volunteer has registered.
\n__v (number): Version key for optimistic concurrency control.
\nThis endpoint is used to delete a specific event by providing the event ID in the URL.
\nMethod: DELETE
\nURL: {{host-events}}/events/666758366bd65f4603006635
Type: Raw
\n{ \"name\": \"Blood Donation\", \"date\": \"2024-05-13\", \"location\": \"MK Ground\", \"description\": \"Raise Awareness about Blood Donation\", \"type\": \"Offline\", \"requiredVolunteers\": [ { \"roleName\": \"Venue Organizers\", \"roleRequirements\": \"Prompt help to people, making arrangements\", \"requiredNumber\": 5 } ], \"registeredVolunteers\": []}
\nThe response for this request is an empty JSON object.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe endpoint makes an HTTP POST request to create a new volunteer at the specified host. The request body should contain the volunteer's name, contact information, skills, availability, areas of interest, and assigned events.
\nname (string, required): The name of the volunteer.
\ncontactInfo (object, required): The contact information of the volunteer.
\nemail (string, required): The email address of the volunteer.
\nphoneNumber (string, required): The phone number of the volunteer.
\nskills (array of strings, required): The skills possessed by the volunteer.
\navailability (string, required): The availability of the volunteer.
\nareasOfInterest (array of strings, required): The areas of interest for the volunteer.
\nassignedEvents (array of objects, required): The events assigned to the volunteer.
\nevent (string, required): The ID of the assigned event.
\nrole (string, required): The role of the volunteer in the event.
\nThe response will be in the form of a JSON schema. An example response for this request is as follows:
\n{\n \"name\": \"\",\n \"contactInfo\": {\n \"email\": \"\",\n \"phoneNumber\": \"\"\n },\n \"skills\": [\"\"],\n \"availability\": \"\",\n \"areasOfInterest\": [\"\"],\n \"assignedEvents\": [\n {\n \"event\": \"\",\n \"role\": \"\",\n \"_id\": \"\"\n }\n ],\n \"_id\": \"\",\n \"__v\": 0\n}\n\nThis endpoint retrieves information about volunteers.
\nThe response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": { \"type\": \"string\" },\n \"contactInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" }\n }\n },\n \"skills\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"availability\": { \"type\": \"string\" },\n \"areasOfInterest\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"assignedEvents\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": { \"type\": \"string\" },\n \"date\": { \"type\": \"string\" },\n \"location\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"requiredVolunteers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"roleName\": { \"type\": \"string\" },\n \"roleRequirements\": { \"type\": \"string\" },\n \"requiredNumber\": { \"type\": \"integer\" }\n }\n }\n },\n \"registeredVolunteers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"volunteer\": { \"type\": \"string\" },\n \"role\": { \"type\": \"string\" }\n }\n }\n }\n }\n },\n \"role\": { \"type\": \"string\" },\n \"_id\": { \"type\": \"string\" }\n }\n }\n },\n \"_id\": { \"type\": \"string\" },\n \"__v\": { \"type\": \"integer\" }\n }\n}\n\nThe endpoint sends an HTTP PUT request to update the details of a volunteer with the specified ID. The request payload should include the volunteer's name, contact information, skills, availability, and areas of interest.
\nname (string): The name of the volunteer.
\ncontactInfo (object): An object containing the volunteer's contact information.
\nemail (string): The email address of the volunteer.
\nphoneNumber (string): The phone number of the volunteer.
\nskills (array of strings): The skills possessed by the volunteer.
\navailability (string): The availability of the volunteer.
\nareasOfInterest (array of strings): The areas of interest for the volunteer.
\nThe response will be a JSON object with the following schema:
\n{\n \"contactInfo\": {\n \"email\": \"\",\n \"phoneNumber\": \"\"\n },\n \"_id\": \"\",\n \"name\": \"\",\n \"skills\": [\"\"],\n \"availability\": \"\",\n \"areasOfInterest\": [\"\"],\n \"assignedEvents\": [\n {\n \"event\": \"\",\n \"role\": \"\",\n \"_id\": \"\"\n }\n ],\n \"__v\": 0\n}\n\nThe response will include the volunteer's contact information, ID, name, skills, availability, areas of interest, and assigned events. All the fields except \"assignedEvents\" will be empty or default values in the response.
\n","urlObject":{"path":["volunteers","66674f136bd65f4603006616"],"host":["{{host-events}}"],"query":[],"variable":[]}},"response":[{"id":"867999cc-c7a3-4611-8f57-905821a7ddbd","name":"Update Volunteer","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"John Dev\",\n \"contactInfo\": {\n \"email\": \"john.dev@example.com\",\n \"phoneNumber\": \"9696546899\"\n },\n \"skills\": [\n \"First Aid\",\n \"Event Planning\"\n ],\n \"availability\": \"Weekends\",\n \"areasOfInterest\": [\n \"Community Service\",\n \"Healthcare\",\n \"Help Elderly\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host-events}}/volunteers/66674f136bd65f4603006616"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"376"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jun 2024 19:20:39 GMT"},{"key":"Etag","value":"W/\"178-KTm3e/aRqzIyxkodpHDIfHJ4iPc\""},{"key":"Replit-Cluster","value":"kirk"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"},{"key":"X-Robots-Tag","value":"none, noindex, noarchive, nofollow, nositelinkssearchbox, noimageindex"}],"cookie":[],"responseTime":null,"body":"{\n \"contactInfo\": {\n \"email\": \"john.dev@example.com\",\n \"phoneNumber\": \"9696546899\"\n },\n \"_id\": \"66674f136bd65f4603006616\",\n \"name\": \"John Dev\",\n \"skills\": [\n \"First Aid\",\n \"Event Planning\"\n ],\n \"availability\": \"Weekends\",\n \"areasOfInterest\": [\n \"Community Service\",\n \"Healthcare\",\n \"Help Elderly\"\n ],\n \"assignedEvents\": [\n {\n \"event\": \"66670184475a3dd635a2daf6\",\n \"role\": \"First Aid\",\n \"_id\": \"66674f136bd65f4603006617\"\n }\n ],\n \"__v\": 0\n}"}],"_postman_id":"02f49514-8cae-48dd-86df-b44252955c36"},{"name":"Delete Volunteer","id":"2f686ded-7768-44b6-bd0a-58c78fe9d977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe4\",\n \"contactInfo\": {\n \"email\": \"john.doe@example.com\",\n \"phoneNumber\": \"9696546899\"\n },\n \"skills\": [\n \"First Aid\",\n \"Event Planning\"\n ],\n \"availability\": \"Weekends\",\n \"areasOfInterest\": [\n \"Community Service\",\n \"Healthcare\"\n ],\n \"assignedEvents\": [\n {\n \"event\": \"66670184475a3dd635a2daf6\",\n \"role\": \"First Aid\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host-events}}/volunteers/6667576c6bd65f460300662b","description":"This endpoint is used to delete a specific volunteer by their unique identifier.
\nMethod: DELETE
\nURL: {{host-events}}/volunteers/6667576c6bd65f460300662b
The request does not require a request body.
\nThe response for this request is an empty JSON object.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\n