{"openapi":"3.0.0","info":{"title":"911inform","description":"911Inform Public Api","contact":{"email":"sdolan@911inform.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.0.3"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/911_inform/live/1.0.3"},{"url":"https://911inform.com/api/v1/lds","description":"911inform Cloud Server"}],"tags":[{"name":"Authentication","description":""},{"name":"User","description":""},{"name":"Location","description":""},{"name":"Notification","description":""},{"name":"LDS","description":""}],"paths":{"/login":{"post":{"tags":["Authentication"],"summary":"Login","description":"Login a User","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginItem"}}},"required":true},"responses":{"200":{"description":"Tokens and User Info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginItemResponse"}}}},"401":{"description":"Invalid Email or Password"},"500":{"description":"Internal Server Error"}}}},"/createUser":{"post":{"tags":["User"],"summary":" Create LDS User","description":"","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserItem"}}},"required":true},"responses":{"201":{"description":"Successfully Created User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponseItem"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Email or AgentID already exists"},"500":{"description":"Internal Server Error"}},"security":[{"bearerAuth":[]}]}},"/patchUser/{id}":{"post":{"tags":["User"],"summary":"Update a User","description":"","parameters":[{"name":"id","in":"path","description":"User ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserItem"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Input data"},"403":{"description":"Missing Required Data"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/getUser/{id}":{"get":{"tags":["User"],"summary":"Get a User","description":"Pull a user object with an Id","parameters":[{"name":"id","in":"path","description":"User ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FortmattedAddressInputItem"}}}},"400":{"description":"Bad Input Parameter"},"401":{"description":"Unauthorized"},"403":{"description":"Missing Data"},"500":{"description":"Internal Server Error"}},"security":[{"bearerAuth":[]}]}},"/getCurrentLocation/{userid}":{"get":{"tags":["Location"],"summary":"Get Users Current Location","description":"Pulls a Current Location based on a User's ID","parameters":[{"name":"userid","in":"path","description":"User ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FavoriteLocationItem"}}}}},"400":{"description":"Bad Input Parameter"},"401":{"description":"Not authenticated"},"409":{"description":"No Locations Available"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/getFormattedLocation":{"post":{"tags":["Location"],"summary":"Gets a Google formatted address","description":"Gets an array of formatted Google address objects based on an inputted address.","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormattedLocationItem"}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressObject"}}}}},"403":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/listFavoriteLocations/{userid}":{"get":{"tags":["Location"],"summary":"Gets a user's favorited locations.","description":"Gets a user's favorited locations.","parameters":[{"name":"userid","in":"path","description":"User ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressObject"}}}}},"403":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/listLocationHistory/{userid}":{"get":{"tags":["Location"],"summary":"Gets a user's location history.","description":"Gets a history of all of a user's locations.","parameters":[{"name":"userid","in":"path","description":"User ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressObject"}}}}},"403":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/favoriteLocation/add":{"post":{"tags":["Location"],"summary":"Add an address object.","description":"Add an address object to a user's favorite addresses list.","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFavoriteLocation"}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressObject"}}}}},"403":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/favoriteLocation/remove":{"post":{"tags":["Location"],"summary":"Remove an address object.","description":"Remove an address object to a user's favorite addresses list.","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFavoriteLocation"}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddressObject"}}}}},"403":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/setLocation":{"post":{"tags":["Location"],"summary":"Sets the current location of a user.","description":"Sets the current location of a user (Not MDA Compatible).","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetLocationItem"}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Missing data"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/sendRegistrationEvent":{"post":{"tags":["LDS"],"summary":"Creates a LDS registration event and notifies the user.","description":"Creates a LDS registration event and notifies the user.","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sendRegistrationEvent"}}},"required":true},"responses":{"200":{"description":"","content":{"text/plain":{"schema":{"type":"string"}}}},"403":{"description":"Invalid or missing input"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}}}},"/connectedBuildings/createNotfication":{"post":{"tags":["Notification"],"summary":"Create a new notification.","description":"Create a new notification.","parameters":[{"name":"Key","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createNotification"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}},"201":{"description":"duplicate","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"bad input parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/connectedBuildings/patchNotfication/{id}":{"post":{"tags":["Notification"],"summary":"Update an existing notification.","description":"Update an existing notification.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createNotification"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}},"403":{"description":"Missing required parameter"},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}},"/connectedBuildings/getNotfication/{id}":{"get":{"tags":["Notification"],"summary":"Get an existing notification.","description":"Get an existing notification.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"JWT":{"schema":{"$ref":"#/components/schemas/Notification"}}}},"401":{"description":"Not authenticated"},"500":{"description":"internal error"}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"LoginItem":{"required":["email","password"],"type":"object","properties":{"email":{"type":"string","example":"test@911inform.com"},"password":{"type":"string","example":"This!Is^MyP4ss"}}},"LoginItemResponse":{"type":"object","properties":{"token":{"type":"string","example":"JWT_Token"},"sessionID":{"type":"string","example":"Session_ID"},"user":{"$ref":"#/components/schemas/UserObjectItem"},"favoriteLocations":{"$ref":"#/components/schemas/FavoriteLocationItem"}}},"UserItem":{"required":["email","ordId","password","releaseDate"],"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"ordId":{"type":"string"},"agentId":{"type":"string"},"phone":{"type":"string"},"bldgId":{"type":"string"}}},"FormattedLocationItem":{"required":["addressLine1","city","state","zipcode"],"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"}}},"AddFavoriteLocation":{"required":["locations","userid"],"type":"object","properties":{"userid":{"type":"string"},"location":{"$ref":"#/components/schemas/AddressObject"}}},"sendRegistrationEvent":{"required":["apiKey","ext","ip","mac","orgId"],"type":"object","properties":{"apiKey":{"type":"string"},"orgId":{"type":"string"},"ip":{"type":"string"},"mac":{"type":"string"},"ext":{"type":"string"},"caller_id":{"type":"string"},"allow_duplicates":{"type":"boolean"}}},"createNotification":{"required":["BuildingId","Source","State","Type"],"type":"object","properties":{"State":{"type":"string"},"Type":{"type":"string"},"Source":{"type":"string"},"BuildingId":{"type":"string"},"Ext":{"type":"string"},"Floor":{"type":"string"},"Provider":{"type":"string"},"Drill":{"type":"string"},"Location_Latitude":{"type":"string"},"location_longitude":{"type":"string"},"location_name":{"type":"string"},"caller_id":{"type":"string"}}},"Notification":{"required":["state"],"type":"object","properties":{"_id":{"type":"object","properties":{"$oid":{"type":"string"}}},"ext":{"type":"string"},"type":{"type":"string"},"source":{"type":"string"},"state":{"type":"string"},"drill":{"type":"boolean"},"training":{"type":"boolean"},"policeonly":{"type":"boolean"},"buildingId":{"type":"string"},"building_Id":{"type":"object","properties":{"$oid":{"type":"string"}}},"orgId":{"type":"object","properties":{"$oid":{"type":"string"}}},"buildingName":{"type":"string"},"readableId":{"type":"string"},"sentTo":{"type":"array","items":{"type":"number"}},"notifyTo":{"type":"array","items":{"type":"number"}},"createdTime":{"type":"object","properties":{"$date":{"type":"string"}}},"roomNum":{"type":"string"},"roomid":{"type":"string"},"extDetail":{"type":"string"},"floor":{"type":"string"},"resolvedInitialExt":{"type":"boolean"},"acknowledge":{"type":"array","items":{"type":"number"}},"closeTime":{"type":"string"},"id":{"type":"string"}}},"UserObjectItem":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"position":{"type":"string"},"picture":{"type":"string"},"key":{"type":"string"},"superUser":{"type":"boolean"},"loginType":{"type":"string"},"invites":{"type":"array","items":{"type":"object","properties":{"orgId":{"type":"string"}}}},"pictureFlag":{"type":"boolean"},"police":{"type":"boolean"},"activeClear":{"type":"boolean"},"activeNot":{"type":"boolean"},"guest":{"type":"boolean"},"notify":{"type":"string"},"phone2":{"type":"string"},"darkmode":{"type":"boolean"},"twoFAEnabled":{"type":"boolean"},"defBldg":{"type":"string"},"language":{"type":"string"},"isChatHidden":{"type":"boolean"},"isChatWindowed":{"type":"boolean"},"isSidenavMinimized":{"type":"boolean"},"isOnline":{"type":"boolean"},"extensions":{"type":"array","items":{"type":"string"}},"registrationType":{"type":"string"},"id":{"type":"number"}}},"CreateUserResponseItem":{"required":["status"],"type":"object","properties":{"message":{"type":"string"},"user":{"$ref":"#/components/schemas/UserObjectItem"}}},"AddressObject":{"type":"object","properties":{"reverse_geocode_results":{"type":"object","properties":{"address_components":{"type":"array","items":{"type":"object","properties":{"long_name":{"type":"string"},"short_name":{"type":"string"},"types":{"type":"array","items":{"type":"string"}}}}},"formatted_address":{"type":"string"},"geometry":{"type":"object","properties":{"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"location_type":{"type":"string"},"viewport":{"type":"object","properties":{"northeast":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"southwest":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}}}}}},"place_id":{"type":"string"},"plus_code":{"type":"object","properties":{"compound_code":{"type":"string"},"global_code":{"type":"string"}}},"types":{"type":"array","items":{"type":"string"}}}},"formatted_address":{"type":"string"},"address_components":{"type":"array","items":{"type":"object","properties":{"long_name":{"type":"string"},"short_name":{"type":"string"},"types":{"type":"array","items":{"type":"string"}}}}},"needed_components":{"type":"array","items":{"type":"object"}},"latitude":{"type":"number"},"longitude":{"type":"number"},"converted":{"type":"boolean"},"country":{"type":"string"},"country_short":{"type":"string"},"postal_code_suffix":{"type":"string"},"postal_code_suffix_short":{"type":"string"},"postal_code":{"type":"string"},"postal_code_short":{"type":"string"},"administrative_area_level_1":{"type":"string"},"administrative_area_level_1_short":{"type":"string"},"administrative_area_level_2":{"type":"string"},"administrative_area_level_2_short":{"type":"string"},"locality":{"type":"string"},"locality_short":{"type":"string"},"route":{"type":"string"},"route_short":{"type":"string"},"street_number":{"type":"string"},"street_number_short":{"type":"string"},"house_number":{"type":"string"},"street_components":{"type":"array","items":{"type":"string"}},"street_suffix":{"type":"string"},"street_prefix":{"type":"string"},"street_name":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}}},"SetLocationItem":{"type":"object","properties":{"userid":{"type":"number"},"location":{"$ref":"#/components/schemas/AddressObject"}}},"FortmattedAddressInputItem":{"required":["addressLine1","city","state","zipcode"],"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"}}},"FavoriteLocationItem":{"type":"object","properties":{"_id":{"type":"string"},"address":{"type":"string"},"userId":{"type":"string"},"buildingName":{"type":"string"},"bandwidthID":{"type":"string"},"endpoint_id":{"type":"string"},"caller_name":{"type":"string"},"phone":{"type":"string"},"bandwith_registered":{"type":"boolean"},"extension":{"type":"string"},"orgId":{"type":"string"},"ip":{"type":"string"},"bldgId":{"type":"string"},"location":{"type":"object","properties":{"reverse_geocode_results":{"type":"object","properties":{"address_components":{"type":"array","items":{"type":"object","properties":{"long_name":{"type":"string"},"short_name":{"type":"string"},"types":{"type":"array","items":{"type":"string"}}}}},"formatted_address":{"type":"string"},"geometry":{"type":"object","properties":{"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"location_type":{"type":"string"},"viewport":{"type":"object","properties":{"northeast":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"southwest":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}}}}}},"partial_match":{"type":"boolean"},"place_id":{"type":"string"},"types":{"type":"array","items":{"type":"string"}}}},"formatted_address":{"type":"string"},"address_components":{"type":"array","items":{"type":"object","properties":{"long_name":{"type":"string"},"short_name":{"type":"string"},"types":{"type":"array","items":{"type":"string"}}}}},"needed_components":{"type":"array","items":{"type":"object"}},"latitude":{"type":"number"},"longitude":{"type":"number"},"converted":{"type":"boolean"},"country":{"type":"string"},"country_short":{"type":"string"},"postal_code":{"type":"string"},"postal_code_short":{"type":"string"},"administrative_area_level_1":{"type":"string"},"administrative_area_level_1_short":{"type":"string"},"administrative_area_level_2":{"type":"string"},"administrative_area_level_2_short":{"type":"string"},"locality":{"type":"string"},"locality_short":{"type":"string"},"route":{"type":"string"},"route_short":{"type":"string"},"street_number":{"type":"string"},"street_number_short":{"type":"string"},"house_number":{"type":"string"},"street_components":{"type":"array","items":{"type":"string"}},"street_suffix":{"type":"string"},"street_prefix":{"type":"string"},"street_name":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"roomid":{"type":"string"},"long":{"type":"number"},"lat":{"type":"number"}}},"phoneId":{"type":"string"},"date":{"type":"string"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}