{"openapi":"3.0.0","title":"345project","info":{"_postman_id":"415f76a0-b8ab-4fb8-8f69-c20b662645cc","name":"345 Project 1","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","_exporter_id":32808831},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/KEBOKAE267/345_v2/1.0.0"}],"tags":[{"name":"developers","description":"Operations available to regular developers"},{"name":"admins","description":"Secured Admin-only calls"}],"paths":{"/getAllReports":{"get":{"tags":["developers"],"summary":"Retrieve all reports","operationId":"getAllReports","responses":{"200":{"description":"search results matching criteria"}}}},"/getReportById/{reportID}":{"get":{"tags":["developers"],"summary":"Retrieve report by reportID","operationId":"getReportById","parameters":[{"name":"reportID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/getStaffAdvert/{STAFFID}":{"get":{"tags":["developers"],"summary":"Retrieve adverts by staff ID","operationId":"getStaffAdvert","parameters":[{"name":"STAFFID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/getAllAdverts":{"get":{"tags":["developers"],"summary":"Retrieve all adverts","operationId":"getAllAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/getAdvert/{ADVERTID}":{"get":{"tags":["developers"],"summary":"Retrieve a single advert by ID","operationId":"getAdvert","parameters":[{"name":"ADVERTID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/getApprovedAdverts/":{"get":{"tags":["developers"],"summary":"Retrieve approved ads","operationId":"getApprovedAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/getPendingAdverts/":{"get":{"tags":["developers"],"summary":"Retrieve pending ads","operationId":"getPendingAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/getRejectedAdverts/":{"get":{"tags":["developers"],"summary":"Retrieve rejected ads","operationId":"getRejectedAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/getSoldAdverts":{"get":{"tags":["developers"],"summary":"Retrieve adverts with tag 'sold'","operationId":"getSoldAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/getAvailableAdverts":{"get":{"tags":["developers"],"summary":"Retrieve adverts with tag 'available'","operationId":"getAvailableAdverts","responses":{"200":{"description":"search results matching criteria"}}}},"/retrieveApprovedAds/{employeeID}":{"get":{"tags":["developers"],"summary":"Retrieve a single staff members approved ads","operationId":"retrieveApprovedAds","parameters":[{"name":"employeeID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/retrieveRejectedAds/{employeeID}":{"get":{"tags":["developers"],"summary":"Retrieve a single members rejected Adverts","operationId":"retrieveRejectedAds","parameters":[{"name":"employeeID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/retrievePendingAds/{employeeID}":null,"get":{"tags":["developers"],"summary":"Retrieve pending adverts by employee ID","operationId":"retrievePendingAds","parameters":[{"name":"employeeID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/retrieveAvailableAds/{employeeID}":{"get":{"tags":["developers"],"summary":"Retrieve available adverts by employee ID","operationId":"retrieveAvailableAds","parameters":[{"name":"employeeID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/retrieveSoldAds/{employeeID}":{"get":{"tags":["developers"],"summary":"Retrieve sold adverts by employee ID","operationId":"retrieveSoldAds","parameters":[{"name":"employeeID","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/getAllAdmins":{"get":{"tags":["developers"],"summary":"Retrieve all admins","operationId":"getAllAdmins","responses":{"200":{"description":"search results matching criteria"}}}},"/getAdminById/{adminId}":{"get":{"tags":["developers"],"summary":"Retrieve admin by ID","operationId":"getAdminById","parameters":[{"name":"adminId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"search results matching criteria"}}}},"/populateAdverts":{"post":{"tags":["developers"],"summary":"Populate the adverts table","operationId":"populateAdverts","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"advertID":{"type":"integer"},"employeeID":{"type":"integer"},"description":{"type":"string"},"status":{"type":"string"},"tag":{"type":"string"},"adminID":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"}},"required":["advertID","employeeID","description","status","tag","adminID","createdAt","modifiedAt"]}}}},"responses":{"200":{"description":"Successfully populated the adverts table"}}}},"/addReport":{"post":{"tags":["developers"],"summary":"Add a report","operationId":"addReport","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reportID":{"type":"integer"},"adminID":{"type":"integer"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"data":{"type":"string"}},"required":["reportID","adminID","startDate","endDate","dateCreated","data"]}}}},"responses":{"200":{"description":"Successfully added the report"}}}},"/staffLogin":{"post":{"tags":["developers"],"summary":"Log in a staff member","operationId":"staffLogin","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}},"required":["email","password"]}}}},"responses":{"200":{"description":"Successfully logged in"}}}},"/modifyAdminById/{adminId}":{"put":{"tags":["developers"],"summary":"Modify admin details by ID","operationId":"modifyAdminById","parameters":[{"name":"adminId","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"200":{"description":"Successfully modified the admin details"}}}},"/modifyAdvertById/{advertId}":{"put":{"tags":["developers"],"summary":"Modify advert details by ID","operationId":"modifyAdvertById","parameters":[{"name":"advertId","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"status":{"type":"string"},"tag":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"Successfully modified the advert details"}}}},"/updateReport/{reportID}":{"put":{"tags":["developers"],"summary":"Update report by reportID","operationId":"updateReport","parameters":[{"name":"reportID","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reportID":{"type":"integer"},"adminID":{"type":"integer"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"data":{"type":"string"}},"required":["reportID","adminID","startDate","endDate","dateCreated","data"]}}}},"responses":{"200":{"description":"Successfully updated the report"}}}}}