{"swagger":"2.0","info":{"description":"4Bells REST API\n","version":"2.0.0","title":"4Bells","contact":{"email":"viktor.lazar@jaystack.com"}},"consumes":["application/json"],"produces":["application/json"],"tags":[{"name":"authentication","description":"Authentication operations"},{"name":"user","description":"User operations"},{"name":"activity","description":"Activity operations"},{"name":"task","description":"Task operations"},{"name":"group","description":"Group operations"},{"name":"category","description":"Category operations"},{"name":"contact","description":"Contact operations"},{"name":"connection","description":"Connection operations"},{"name":"admin","description":"Admin features"},{"name":"anonymous","description":"Anonymous features"}],"paths":{"/login":{"post":{"summary":"Login user","operationId":"login","tags":["authentication"],"parameters":[{"name":"Authorization","in":"header","description":"Authentication username/email and password","required":true,"type":"string"}],"responses":{"200":{"description":"Login successful","headers":{"Authorization":{"description":"Session token to authenticate logged in user","type":"string"}}},"401":{"description":"Access denied"}}}},"/logout":{"post":{"summary":"Logout user","operationId":"logout","tags":["authentication"],"security":[{"token":[]}],"responses":{"200":{"description":"Logout successful"},"401":{"description":"Access denied"}}}},"/forgotpassword":{"post":{"summary":"Send password reset email","operationId":"forgotPassword","tags":["authentication"],"parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"email":{"type":"string"}}}}],"responses":{"200":{"description":"Email sent with password reset"},"401":{"description":"Access denied"}}}},"/changepassword":{"post":{"summary":"Change password","operationId":"changePassword","tags":["authentication"],"security":[{"token":[]}],"parameters":[{"in":"body","name":"body","description":"New password","required":true,"schema":{"type":"object","properties":{"password":{"type":"string"}}}}],"responses":{"200":{"description":"Password changed successfully"}}}},"/contactus":{"post":{"summary":"Send contact us email to Caravan Studios","operationId":"sendContactUs","tags":["anonymous"],"parameters":[{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/ContactUs"}}],"responses":{"200":{"description":"Contact us sent successfully"}}}},"/users":{"post":{"summary":"Register new user","operationId":"createUser","tags":["user"],"parameters":[{"in":"body","name":"body","description":"New user initial data","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"User created successfully"}}}},"/user":{"put":{"summary":"Update authenticated user","operationId":"updateUser","tags":["user"],"security":[{"token":[]}],"parameters":[{"in":"body","name":"body","description":"Updated user data","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"User updated successfully"}}},"get":{"summary":"Get authenticated user","operationId":"getUser","tags":["user"],"security":[{"token":[]}],"responses":{"200":{"description":"Authenticated user data","schema":{"$ref":"#/definitions/User"}}}}},"/user/tasks":{"post":{"summary":"Connect task to authenticated user","operationId":"connectTask","tags":["user","task"],"security":[{"token":[]}],"parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["claim","unclaim","decline","complete","incomplete"]}}}}}],"responses":{"200":{"description":"Task connected"}}}},"/user/tasks/{taskId}":{"delete":{"summary":"Disconnect task from authenticated user","operationId":"disconnectTask","tags":["user","task"],"security":[{"token":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Task disconnected"}}}},"/users/{userId}/tasks":{"post":{"summary":"Connect task to user","operationId":"connectTaskToUser","tags":["task","admin"],"security":[{"token":[]}],"parameters":[{"name":"userId","in":"path","description":"user id","required":true,"type":"integer","format":"in32"},{"name":"body","in":"body","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["claim","unclaim","decline","complete","incomplete"]}}}}}],"responses":{"200":{"description":"Task connected to user"}}}},"/users/{userId}/tasks/{taskId}":{"delete":{"summary":"Disconnect task from user","operationId":"disconnectTaskFromUser","tags":["user","task"],"security":[{"token":[]}],"parameters":[{"name":"userId","in":"path","description":"user id","required":true,"type":"integer","format":"in32"},{"name":"taskId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Task disconnected from user"}}}},"/activities":{"get":{"summary":"Get all activities","operationId":"getActivities","tags":["activity"],"security":[{"token":[]}],"parameters":[{"name":"page","in":"query","description":"page of activities","type":"integer","format":"int32","default":0},{"name":"type","in":"query","description":"filter by activity type","type":"array","items":{"type":"string"}}],"responses":{"200":{"description":"Get activites for logged in user","schema":{"type":"array","items":{"$ref":"#/definitions/Activity"}}}}}},"/activities/{activityId}":{"delete":{"summary":"Remove activity","operationId":"removeActivity","tags":["activity"],"security":[{"token":[]}],"parameters":[{"name":"activityId","in":"path","required":true,"description":"id of the activity to remove","type":"integer","format":"int32"}],"responses":{"200":{"description":"Activity removed successfully"}}}},"/tasks":{"post":{"summary":"Create new task","operationId":"createTask","tags":["task"],"security":[{"token":[]}],"parameters":[{"name":"body","in":"body","required":true,"description":"new task data","schema":{"$ref":"#/definitions/Task"}}],"responses":{"200":{"description":"Task created successfully"}}},"get":{"summary":"Get tasks","operationId":"getTasks","tags":["task"],"security":[{"token":[]}],"parameters":[{"name":"page","in":"query","description":"result page","type":"integer","format":"int32","default":0},{"name":"size","in":"query","description":"result page size","type":"integer","format":"int32","default":0},{"name":"type","in":"query","description":"task type","type":"string","enum":["claimed","open","closed"],"default":0}],"responses":{"200":{"description":"Get tasks for logged in user","schema":{"type":"array","items":{"$ref":"#/definitions/Task"}}}}}},"/tasks/{taskId}":{"get":{"summary":"Get task details","operationId":"getTaskDetails","tags":["task"],"security":[{"token":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns task details","schema":{"$ref":"#/definitions/TaskDetails"}}}},"put":{"summary":"Update task","operationId":"updateTask","tags":["task"],"security":[{"token":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/Task"}}],"responses":{"200":{"description":"Task updated successfully"}}},"delete":{"summary":"Cancel task","operationId":"cancelTask","tags":["admin","task"],"security":[{"token":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Admin cancelled task"}}}},"/groups":{"get":{"summary":"Get all groups for authenticated user","operationId":"getGroups","tags":["group"],"security":[{"token":[]}],"responses":{"200":{"description":"Returns all groups for logged in user","schema":{"$ref":"#/definitions/GroupList"}}}},"post":{"summary":"Create new group","operationId":"createGroup","tags":["group"],"security":[{"token":[]}],"parameters":[{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/GroupDetails"}}],"responses":{"200":{"description":"Group created successfully"}}}},"/groups/joinrequests":{"post":{"summary":"Request group join","operationId":"requestGroupJoin","tags":["group","connection"],"parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"connectioncode":{"type":"integer","format":"int32"}}}}],"responses":{"200":{"description":"Join request result","schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"}}}}}}},"/groups/{groupId}":{"get":{"summary":"Get group details","operationId":"getGroupDetails","tags":["group"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Return group details","schema":{"$ref":"#/definitions/GroupDetails"}}}},"put":{"summary":"Update group","operationId":"updateGroup","tags":["group"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/GroupDetails"}}],"responses":{"200":{"description":"Group updated successfully"}}},"delete":{"summary":"Delete group","operationId":"removeGroup","tags":["group"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Group removed successfully"}}}},"/groups/{groupId}/categories":{"get":{"summary":"Get all categories","operationId":"getGroupCategories","tags":["group","category"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Return group categories by group id","schema":{"type":"array","items":{"$ref":"#/definitions/Category"}}}}},"post":{"summary":"Add category","operationId":"addGroupCategory","tags":["group","category"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/Category"}}],"responses":{"200":{"description":"Group category created successfully"}}}},"/groups/{groupId}/categories/{categoryId}":{"delete":{"summary":"Remove category","operationId":"removeGroupCategory","tags":["group","category"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"categoryId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Group category removed successfully"}}}},"/groups/{groupId}/categories/{categoryId}/subscription":{"post":{"summary":"Subscribe to category","operationId":"subscribeCategory","tags":["group","category","user"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"categoryId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Subscribed to group category successfully"}}},"delete":{"summary":"Unsubscribe from category","operationId":"unsubscribeCategory","tags":["group","category","user"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"categoryId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Unsubscribed from group category successfully"}}}},"/groups/{groupId}/categories/{categoryId}/subscription/{userId}":{"post":{"summary":"Approve category subscription of user","operationId":"approveCategorySubscriptionByUserId","tags":["group","category","user","admin"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"categoryId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Approved subscription"}}},"delete":{"summary":"Reject category subscription of user","operationId":"rejectCategorySubscriptionByUserId","tags":["group","category","user","admin"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"categoryId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Rejected subscription"}}}},"/groups/{groupId}/contacts":{"get":{"summary":"Get all contacts","operationId":"getGroupContacts","tags":["group","contact"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Return group contacts by group id","schema":{"type":"array","items":{"$ref":"#/definitions/Contact"}}}}},"post":{"summary":"Add contact","operationId":"addGroupContact","tags":["group","contact"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/Contact"}}],"responses":{"200":{"description":"New group contact created successfully"}}}},"/groups/{groupId}/contacts/{contactId}":{"delete":{"summary":"Remove contact","operationId":"removeGroupContact","tags":["group","contact"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"contactId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Group contact removed successfully"}}}},"/categories":{"get":{"summary":"Get global categories","operationId":"getGlobalCategories","tags":["category"],"security":[{"token":[]}],"responses":{"200":{"description":"Return all global categories","schema":{"type":"array","items":{"$ref":"#/definitions/Category"}}}}}},"/group/{groupId}/users":{"post":{"summary":"Create user connection in group","operationId":"connectGroup","tags":["group","connection"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"body","in":"body","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}],"responses":{"200":{"description":"Connected to group successfully"}}},"delete":{"summary":"Delete authenticated user connection from group","operationId":"disconnectGroup","tags":["group","connection"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Disconnected from group successfully"}}}},"/groups/{groupId}/users/{userId}":{"delete":{"summary":"Disconnect the user from the group","operationId":"disconnectGroupByUserId","tags":["group","connection","admin"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"userId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Disconnected user from group successfully"}}}},"/groups/{groupId}/volunteers":{"post":{"summary":"Demote user to volunteer","operationId":"demoteToVolunteer","tags":["user","admin"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","description":"group id","required":true,"type":"integer","format":"in32"},{"name":"body","in":"body","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"User demoted to volunteer"}}}},"/groups/{groupId}/admins":{"post":{"summary":"Promote user to admin","operationId":"promoteToAdmin","tags":["user","admin"],"security":[{"token":[]}],"parameters":[{"name":"groupId","in":"path","description":"group id","required":true,"type":"integer","format":"in32"},{"name":"body","in":"body","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"User promoted to admin"}}}}},"securityDefinitions":{"token":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"Activity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"text":{"type":"string"},"html":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"target":{"type":"string"},"groupTarget":{"type":"string"},"type":{"$ref":"#/definitions/ActivityType"}}},"ActivityType":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string"},"deactivate":{"type":"string"}}},"BaseTask":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"startdate":{"type":"string","format":"date-time"},"enddate":{"type":"string","format":"date-time"},"group":{"$ref":"#/definitions/Group"},"status":{"type":"string"},"volunteerneeded":{"type":"integer","format":"int32"}}},"TaskList":{"type":"array","items":{"allOf":[{"$ref":"#/definitions/BaseTask"},{"type":"object","properties":{"claimed":{"$ref":"#/definitions/BaseUser"},"claimcount":{"type":"integer","format":"int32"}}}]}},"Task":{"allOf":[{"$ref":"#/definitions/BaseTask"},{"type":"object","properties":{"description":{"type":"string"},"owner":{"$ref":"#/definitions/UserContact"},"startlocation":{"$ref":"#/definitions/Location"},"endlocation":{"$ref":"#/definitions/Location"},"contacts":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"categories":{"type":"array","items":{"$ref":"#/definitions/Category"}}}}]},"TaskDetails":{"allOf":[{"$ref":"#/definitions/Task"},{"type":"object","properties":{"claims":{"type":"array","items":{"$ref":"#/definitions/Claim"}},"volunteer":{"$ref":"#/definitions/User"},"history":{"type":"array","items":{"$ref":"#/definitions/History"}}}}]},"Location":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"address":{"type":"string"},"lat":{"type":"number","format":"double"},"lng":{"type":"number","format":"double"}}},"UserContact":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"phone":{"type":"string"},"phoneraw":{"type":"string"},"phoneformatted":{"type":"string"},"email":{"type":"string"}}},"Contact":{"allOf":[{"$ref":"#/definitions/UserContact"},{"type":"object","properties":{"status":{"type":"string"}}}]},"Claim":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"user":{"$ref":"#/definitions/UserClaim"}}},"Category":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"}}},"History":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"comment":{"type":"string"},"logdate":{"type":"string","format":"date-time"},"status":{"type":"string"},"user":{"$ref":"#/definitions/UserClaim"}}},"Group":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"role":{"type":"string","enum":["volunteer","admin"]}}},"GroupList":{"type":"array","items":{"$ref":"#/definitions/Group"}},"GroupDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"postalcode":{"type":"string"},"city":{"type":"string"},"connectioncode":{"type":"integer","format":"int32"},"status":{"type":"string"},"maxsmscount":{"type":"integer","format":"int32"},"approvevolunteer":{"type":"boolean"},"profile":{"$ref":"#/definitions/GroupProfile"}}},"GroupProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"maxsmscount":{"type":"integer","format":"int32"}}},"ContactUs":{"type":"object","properties":{"isFeedback":{"type":"boolean"},"fullname":{"type":"string"},"email":{"type":"string"},"message":{"type":"string"}}},"BaseUser":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"username":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"}}},"UserClaim":{"allOf":[{"$ref":"#/definitions/BaseUser"},{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"phoneraw":{"type":"string"},"phoneformatted":{"type":"string"}}}]},"User":{"allOf":[{"$ref":"#/definitions/UserClaim"},{"type":"object","properties":{"password":{"type":"string"},"sms":{"type":"boolean"},"push":{"type":"boolean"},"device":{"type":"string"},"token":{"type":"string"},"keeplogin":{"type":"boolean"}}}]}},"host":"virtserver.swaggerhub.com","basePath":"/CaravanStudios/4bells/2.0.0","schemes":["https","http"]}