The Yottabyte REST API makes the connection between our clients (the website and the mobile app) and our server.
\nYou can use the whole API with only Postman, without the need of our clients. This documentation will help you getting started!
\nTo start sending requests to the Yottabyte API, make sure that you have the right domain!
\nFor example, if you want to send requests to the production server, the domain will be:
\nyottabyte.azurewebsites.net\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"14581342","collectionId":"f470348f-67bf-4bac-9350-f4b40b9998f7","publishedId":"UyxgHncX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-11T11:09:17.000Z"},"item":[{"name":"Yottabyte - User","item":[{"name":"Yottabyte - Register User","id":"b22560ba-cdc0-4a98-a6fa-98f3e8af262b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"FName","value":"Albena","type":"text","description":"Or, if you want to use custom server, then change the domain to your own.
\n
The first name of the user.
\n"},{"key":"LName","value":"Mihaylova","type":"text","description":"The last name of the user.
\n"},{"key":"Email","value":"AMhaylova@outlook.com","type":"text","description":"The email of the user.
\n"},{"key":"Password","value":"VerySectretPassword123","type":"text","description":"The password of the user.
\n"},{"key":"Avatar","type":"file","description":"[Optional] Avatar of the user. If an avatar is not given, a random one will be chosen.
\n","src":"/C:/Users/SSIvanov19/Pictures/avatar.jpg","disabled":true}]},"url":"https://localhost:44397/api/users/register","description":"The Yottabyte - Register User endpoint is used to register an user into our platform!
\nYou will get different response based on the data that you send. For example: a successful request will return:
\n{\n \"type\": \"user-register-success\",\n \"data\": null\n}\n\nIf there is problem with the validation, your response will be something similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceId\": \"00-73d93b845014194a98bacd360e80575d-cf726bc354db7b45-00\",\n \"errors\": {\n \"FName\": [\n \"The field FName must match the regular expression '^(?=.*[A-ZAa-z])([A-Z])([a-z]{2,29})$'.\"\n ]\n }\n}\n\nIf there is problem with the file extension of the image, your response will be something similar to this one:
\n{\n \"type\": \"user-register-failure\",\n \"data\": \"The file extension of avatar image is invalid\"\n}\n\nIf there is already a user with this username or email your response will be similar to this one:
\n{\n \"type\": \"user-register-failure\",\n \"data\": \"There is already a user with this email\"\n}\n\nThe email of the user.
\n"},{"key":"Password","value":"VerySectretPassword123","type":"text","description":"The password of the user.
\n"}]},"url":"https://localhost:44397/api/users/login","description":"The Yottabyte - Login User endpoint is used to login an user into our platform!
\nYou will get different response based on the data that you send. For example a successful request will return:
\n{\n \"type\": \"user-login-success\",\n \"data\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIymIisImlzQWRtaW32OihGmWxZzsEsIm5iZiI6MTY1MjI1NDY4NywiZXhwIjoxNjUyMzQxMDg3LCJpYXQiOjE2NTIyNTQ2ODd9.Z012_y0JMhfDjHRBCinApsO5pL7aCGyghLHBGDunSoA\"\n}\n\n\n\nThe data field holds the JWT Token for this user.
\n
If there is problem with the validation, your response will be something similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceId\": \"00-73d93b845014194a98bacd360e80575d-cf726bc354db7b45-00\",\n \"errors\": {\n \"FName\": [\n \"The field FName must match the regular expression '^(?=.*[A-ZAa-z])([A-Z])([a-z]{2,29})$'.\"\n ]\n }\n}\n\nIf the email is incorrect your response will be similar to this one:
\n{\n \"type\": \"user-login-failure\",\n \"data\": \"There isn't a user with this email!\"\n}\n\nIf the password is incorrect your response will be similar to this one:
\n{\n \"type\": \"user-login-failure\",\n \"data\": \"The password is incorrect!\"\n}\n\nThe Yottabyte - Get User with Id endpoint is used to get user information by the id of the user.
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\n
You will get different response based on the data that you send. For example a successful request will return:
\n{\n \"id\": 23,\n \"fName\": \"Albena\",\n \"lName\": \"Mihaylova\",\n \"email\": \"AMhaylova@outlook.com\",\n \"avatarURL\": \"https://avatars.dicebear.com/api/identicon/1652266085,9873948.svg\"\n}\n\nIf no JWT Token is given, you response will be empty with status code of 401!
\nIf there isn't a user with this id, your response will be similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-dd4c096b360d6148a23114ced18b6aa2-41a84d277c97c542-00\"\n}\n\nThe Id of the user
\n","type":"text/plain"},"type":"any","value":"24","key":"id"}]}},"response":[],"_postman_id":"b76ff683-5ce4-4371-834f-d96dd780e976"},{"name":"Yottabyte - Get User with Id","id":"b6f20625-14ee-449a-88ad-cec27d5dbded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Yottabyte - Get User with Id endpoint is used to get user information by the id of the user.
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\n
You will get different response based on the data that you send. For example a successful request will return:
\n{\n \"id\": 23,\n \"fName\": \"Albena\",\n \"lName\": \"Mihaylova\",\n \"email\": \"AMhaylova@outlook.com\",\n \"avatarURL\": \"https://avatars.dicebear.com/api/identicon/1652266085,9873948.svg\"\n}\n\nIf no JWT Token is given, you response will be empty with status code of 401!
\nIf there isn't a user with this id, your response will be similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-dd4c096b360d6148a23114ced18b6aa2-41a84d277c97c542-00\"\n}\n\nThe Id of the user
\n","type":"text/plain"},"type":"any","value":"24","key":"id"}]}},"response":[{"id":"7c7a4c03-cd60-461b-8d0b-135c53ac1822","name":"Yottabyte - Get User with Id - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://localhost:44397/api/users/:id","protocol":"https","host":["localhost"],"port":"44397","path":["api","users",":id"],"variable":[{"key":"id","value":"23","description":"The Id of the user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 11 May 2022 07:48:41 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 23,\n \"fName\": \"Albena\",\n \"lName\": \"Mihaylova\",\n \"email\": \"AMhaylova@outlook.com\",\n \"avatarURL\": \"https://avatars.dicebear.com/api/identicon/1652266085,9873948.svg\"\n}"},{"id":"c4287ecc-0b83-42f6-8872-d51c3a612ffb","name":"Yottabyte - Get User with Id - No JWT Token is given","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://localhost:44397/api/users/:id","protocol":"https","host":["localhost"],"port":"44397","path":["api","users",":id"],"variable":[{"key":"id","value":"23","description":"The Id of the user"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 11 May 2022 08:03:54 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"f9f39284-5666-48d6-a6cc-7da87645938d","name":"Yottabyte - Get User with Id - User Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://localhost:44397/api/users/:id","protocol":"https","host":["localhost"],"port":"44397","path":["api","users",":id"],"variable":[{"key":"id","value":"24","description":"The Id of the user"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/problem+json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 11 May 2022 08:05:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"traceId\": \"00-dd4c096b360d6148a23114ced18b6aa2-41a84d277c97c542-00\"\n}"}],"_postman_id":"b6f20625-14ee-449a-88ad-cec27d5dbded"},{"name":"Yottabyte - Get All Users","id":"ff9dd0c4-acfc-4375-8697-0ab607305e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Yottabyte - Get All User endpoint is used to get all users information.
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\n
You will get different response based on the data that you send. For example a successful request will return something similar to this:
\n[\n {\n \"id\": 19,\n \"fName\": \"Pesho\",\n \"lName\": \"Jaka\",\n \"email\": \"PJaka@outlook.com\",\n \"avatarURL\": \"https://media.discordapp.net/attachments/934036037922078754/943359321088090202/unknown.png\"\n },\n {\n \"id\": 23,\n \"fName\": \"Albena\",\n \"lName\": \"Mihaylova\",\n \"email\": \"AMhaylova@outlook.com\",\n \"avatarURL\": \"https://avatars.dicebear.com/api/identicon/1652266085,9873948.svg\"\n }\n]\n\nIf no JWT Token is given, you response will be empty with status code of 401!
\n","urlObject":{"protocol":"https","port":"5001","path":["api","users",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff9dd0c4-acfc-4375-8697-0ab607305e55"},{"name":"Yottabyte - Update User","id":"780ee65a-1799-42f7-aa46-c870cebde778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The first name of the user.
\n"},{"key":"LName","value":"Mihaylova","type":"text","description":"The last name of the user.
\n"},{"key":"Email","value":"AMhaylova@outlook.com","type":"text","description":"The email of the user.
\n"},{"key":"Password","value":"NewVerySectretPassword123","type":"text","description":"The password of the user.
\n"},{"key":"Avatar","type":"file","description":"[Optional] Avatar of the user. If an avatar is not given, a random one will be chosen.
\n","src":"/C:/Users/SSIvanov19/Pictures/avatar.jpg","disabled":true}]},"url":"https://localhost:44397/api/users/:id","description":"The Yottabyte - Update User endpoint is used to update the user into our platform!
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\nApart from users can not change other user information. Only admins can do that!
\n
You will get deferent response based on the data that you send. For example a successful request will return:
\n{\n \"type\": \"user-update-success\",\n \"data\": null\n}\n\nIf there is problem with the validation, your response will be something similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceId\": \"00-73d93b845014194a98bacd360e80575d-cf726bc354db7b45-00\",\n \"errors\": {\n \"FName\": [\n \"The field FName must match the regular expression '^(?=.*[A-ZAa-z])([A-Z])([a-z]{2,29})$'.\"\n ]\n }\n}\n\nIf there is problem with the file extension of the image, your response will be something similar to this one:
\n{\n \"type\": \"user-update-failure\",\n \"data\": \"The file extension of avatar image is invalid\"\n}\n\nIf you are not an admin and try to update other user info, you will get the following response:
\n","urlObject":{"protocol":"https","port":"44397","path":["api","users",":id"],"host":["localhost"],"query":[],"variable":[{"description":{"content":"The Id of the user
\n","type":"text/plain"},"type":"any","value":"18","key":"id"}]}},"response":[],"_postman_id":"780ee65a-1799-42f7-aa46-c870cebde778"},{"name":"Yottabyte - Delete User","id":"510c36c1-47e3-46e3-8b89-ad1b22d9d6ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Yottabyte - Delete User endpoint is used to delete the user into our platform!
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\nApart from this users can not delete other user information. Only admins can do that!
\n
You will get different response based on the data that you send. For example a successful request will return:
\n{\n \"type\": \"user-deletion-success\",\n \"data\": null\n}\n\nIf you are not an admin and try to delete other user info, you will get the following response:
\n{\n \"type\": \"user-deletion-failure\",\n \"data\": \"The user isn't an admin\"\n}\n\nIf there isn't a user with this id, your response will be similar to this one:
\n{\n \"type\": \"user-deletion-failure\",\n \"data\": \"There isn't a user with this id\"\n}\n\nThe Id of the user
\n","type":"text/plain"},"type":"any","value":"23","key":"id"}]}},"response":[],"_postman_id":"510c36c1-47e3-46e3-8b89-ad1b22d9d6ab"}],"id":"0bc715c5-cf47-4745-b181-b2b4b048e60c","description":"The Yottabyte - User folder holds all the the requests, connected to the user management.
\n","_postman_id":"0bc715c5-cf47-4745-b181-b2b4b048e60c"},{"name":"Yottabyte - Event","item":[{"name":"Yottabyte - Create New Event","id":"c77cfc2f-729b-4d9d-957a-222c89158eb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Longitude of the image
\n"},{"key":"Lat","value":"42.068988","type":"text","description":"Latitude of the image
\n"},{"key":"Image","type":"file","description":"The image of the beach
\n","src":"/C:/Users/SSIvanov19/Documents/pictures/pictures/unclear-7.png"}]},"url":"https://localhost:44397/api/events/createnewevent","description":"The Yottabyte - Create New Event endpoint is used to create new event into our platform!
\nYou will get different response based on the data that you send. For example a successful request will return:
\n{\n \"type\": \"event-create-success\",\n \"data\": null\n}\n\nIf there is problem with the validation, your response will be something similar to this one:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceId\": \"00-831eb91026ee1f4fb4ef9d3692ae7892-4b7e0128d33e6145-00\",\n \"errors\": {\n \"Lat\": [\n \"The field Lat must match the regular expression '^(\\\\+|-)?(?:90(?:(?:\\\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\\\.[0-9]{1,6})?))$'.\"\n ],\n \"Long\": [\n \"The field Long must match the regular expression '^(\\\\+|-)?(?:180(?:(?:\\\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\\\.[0-9]{1,6})?))$'.\"\n ],\n \"Image\": [\n \"The Image field is required.\"\n ]\n }\n}\n\nIf there is problem with the file extension of the image, your response will be something similar to this one:
\n{\n \"type\": \"event-create-failure\",\n \"data\": \"The file extension of the image is invalid\"\n}\n\nIf there is already an active event on this place, your response will be similar to this one:
\n{\n \"type\": \"event-create-failure\",\n \"data\": \"There is already event in this place and it is active\"\n}\n\nThe Yottabyte - Event User endpoint is used to delete the user into our platform!
\n\n\nThis API endpoint is protected. You will need a valid JWT Token to access it. Such token can be taken from the login endpoint.
\nOnly admins can delete events!
\n
You will get different response based on the data that you send. For example a successful request will return:
\n{\n \"type\": \"event-deletion-success\",\n \"data\": null\n}\n\nIf you are not an admin and try to delete event, you will get the following response:
\n{\n \"type\": \"event-deletion-failure\",\n \"data\": \"The user isn't an admin\"\n}\n\nIf there isn't an event with this id, your response will be similar to this one:
\n{\n \"type\": \"event-deletion-failure\",\n \"data\": \"There isn't an event with this id\"\n}\n\nId of the event
\n","type":"text/plain"},"type":"any","value":"10","key":"id"}]}},"response":[],"_postman_id":"905c319a-2e0e-4ad4-997c-f19dbd9ab314"}],"id":"d2c7c774-b3fb-4c55-a501-73245d417298","description":"The Yottabyte - Event folder holds all the the requests, connected to the event management.
\n","_postman_id":"d2c7c774-b3fb-4c55-a501-73245d417298"}]}