{"swagger":"2.0","info":{"description":"This is a sample server Emembership server.  You can find \nout more about Swagger at \n[http://swagger.io](http://swagger.io) or on \n[irc.freenode.net, #swagger](http://swagger.io/irc/).\n","version":"1.0.0","title":"A2Z API","termsOfService":"http://swagger.io/terms/","contact":{"email":"hbbsolutions@gmail.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"Category","description":"Access to Category"},{"name":"Comment","description":"Access to comment."},{"name":"Mail","description":"Access to mail"},{"name":"Notification","description":"Access to Notification"},{"name":"Order","description":"Access to order"},{"name":"Product","description":"Access to product"},{"name":"Request","description":"Access to request"},{"name":"User","description":"Access to user"},{"name":"Congif","description":"Return common resource( list category, config..)","externalDocs":{"description":"Find out more about our store","url":"http://swagger.io"}}],"paths":{"/users/register":{"post":{"tags":["user"],"summary":"Sign Up a new user","description":"This can be done by any users.","operationId":"registerUser","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"in":"body","description":"Created user object.","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"success":{"description":"successful operation. Return `data = {}`","schema":{"$ref":"#/definitions/UserResponse"}},"1501":{"description":"email param invalid."},"1502":{"description":"password param invalid."},"1511":{"description":"fullname param invalid."},"1512":{"description":"gender param invalid."},"1513":{"description":"birthday param invalid."},"1514":{"description":"address param invalid."},"1003":{"description":"errorCode `300` - user already exist."},"1002":{"description":"errorCode `301` - user can not be created."},"1401":{"description":"errorCode `400` - card can not be created."},"404":{"description":"errorCode `404`  - not found."},"500":{"description":"errorCode `500`  - internal server error."}}}},"/users/registerAdmin":{"post":{"tags":["user","admin"],"summary":"Sign Up a new admin user","description":"This can be done by ADMIN users.","operationId":"registerAdminUser","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"in":"body","description":"Created user object.","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"success":{"description":"successful operation. Return `data = {}`","schema":{"$ref":"#/definitions/UserResponse"}},"1501":{"description":"email param invalid."},"1502":{"description":"password param invalid."},"1511":{"description":"fullname param invalid."},"1512":{"description":"gender param invalid."},"1513":{"description":"birthday param invalid."},"1514":{"description":"address param invalid."},"1003":{"description":"errorCode `300` - user already exist."},"1002":{"description":"errorCode `301` - user can not be created."},"1401":{"description":"errorCode `400` - card can not be created."},"404":{"description":"errorCode `404`  - not found."},"500":{"description":"errorCode `500`  - internal server error."}}}},"/users/login":{"post":{"tags":["user"],"summary":"Logs user into the system","operationId":"loginUser","produces":["application/json"],"parameters":[{"name":"email","in":"body","description":"The user email for login. Format as `email` type.","required":true,"type":"string"},{"name":"password","in":"body","description":"The password for login in clear text. Format as minLenght = 8","required":true,"type":"string"},{"name":"deviceToken","in":"body","description":"The device UUID token.","required":false,"type":"string"}],"responses":{"success":{"description":"successful operation. Return  `data = {}`","schema":{"$ref":"#/definitions/UserResponse"}},"1501":{"description":"email param invalid."},"1502":{"description":"password param invalid."},"1503":{"description":"deviceToken param invalid."},"401":{"description":"Unauthorized."},"404":{"description":"errorCode `404` - not found."},"500":{"description":"errorCode `500` - internal server error."}}}},"/users/loginAdmin":{"post":{"tags":["user","admin"],"summary":"Logs admin user into the system","operationId":"loginAdminUser","produces":["application/json"],"parameters":[{"name":"email","in":"body","description":"The user email for login. Format as `email` type.","required":true,"type":"string"},{"name":"password","in":"body","description":"The password for login in clear text. Format as minLenght = 8","required":true,"type":"string"}],"responses":{"success":{"description":"successful operation. Return  `data = {}`","schema":{"$ref":"#/definitions/UserResponse"}},"1501":{"description":"email param invalid."},"1502":{"description":"password param invalid."},"1503":{"description":"deviceToken param invalid."},"401":{"description":"Unauthorized."},"404":{"description":"errorCode `404` - not found."},"500":{"description":"errorCode `500` - internal server error."}}}},"/users/profile":{"put":{"tags":["user"],"summary":"Update user profile","description":"This can be done by loggined users.","operationId":"updateUser","produces":["application/json"],"parameters":[{"in":"body","name":"fullname","type":"string","description":"Fullname."},{"name":"password","in":"body","type":"string","description":"user password. minLenght = 8"},{"name":"gender","in":"body","type":"boolean","description":"user gender. `0` or `1`"},{"name":"birthday","in":"body","type":"date-time","description":"user birthday"},{"name":"address","in":"body","type":"string","description":"user address"},{"name":"phone","in":"body","type":"string","description":"user phone number"}],"responses":{"success":{"description":"successful operation. Return `data = {}`","schema":{"$ref":"#/definitions/UserResponse"}},"1501":{"description":"email param invalid."},"1502":{"description":"password param invalid."},"1511":{"description":"fullname param invalid."},"1512":{"description":"gender param invalid."},"1513":{"description":"birthday param invalid."},"1514":{"description":"address param invalid."},"401":{"description":"Unauthorized."},"404":{"description":"errorCode `404` - not found."},"500":{"description":"errorCode `500` - internal server error."}}}},"/users/logout":{"put":{"tags":["user"],"summary":"Logs out current logged in user session","operationId":"logoutUser","produces":["application/json"],"parameters":[{"name":"deviceToken","in":"body","description":"The device UUID token.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation. Return empty"},"404":{"description":"errorCode `-1` - not found."},"500":{"description":"errorCode `-1` - internal server error."}}}},"/users/changePassword":{"put":{"tags":["user"],"summary":"Change user password.","operationId":"changeUserPassword","produces":["application/json"],"parameters":[{"name":"oldPassword","in":"body","description":"The old password. Format as minLenght = 8","required":true,"type":"string"},{"name":"newPassword","in":"body","description":"The new password. Format as minLength = 8","type":"string","required":true}],"responses":{"success":{"description":"successful operation. Return empty"},"1502":{"description":"password param invalid."},"1004":{"description":"oldPassword not match."},"401":{"description":"Unauthorized."},"404":{"description":"not found."},"500":{"description":"internal server error."}}}},"/users/forgetPassword":{"put":{"tags":["user"],"summary":"Forget user password.","operationId":"forgetUserPassword","produces":["application/json"],"parameters":[{"name":"email","in":"body","description":"The user email. Format as `email`","required":true,"type":"string"}],"responses":{"success":{"description":"successful operation. Return empty"},"1501":{"description":"email param invalid."},"401":{"description":"Unauthorized."},"404":{"description":"not found."},"500":{"description":"internal server error."}}}},"/users/validate":{"put":{"tags":["user"],"summary":"Validate email exist or not","description":"This can be done by any users.","operationId":"validateUserEmail","produces":["application/json"],"parameters":[{"in":"body","name":"email","description":"Email for validating.","required":true,"type":"string"}],"responses":{"success":{"description":"successful operation. Return `data = {}`"},"1501":{"description":"email invalid params."},"1001":{"description":"email already exist."},"401":{"description":"Unauthorized."},"404":{"description":"not found."},"500":{"description":"internal server error."}}}},"/users/notification":{"put":{"tags":["user"],"summary":"On/Off receive notification.","description":"This can be done by loggined users.","operationId":"toggleNotification","produces":["application/json"],"parameters":[{"in":"body","name":"allowed","description":"Allow receive push notification or not.","required":true,"type":"boolean","default":false}],"responses":{"success":{"description":"successful operation. Return `data = {}`"},"401":{"description":"Unauthorized."},"404":{"description":"not found."},"500":{"description":"internal server error."}}}}},"securityDefinitions":{"petstore_auth":{"type":"oauth2","authorizationUrl":"http://petstore.swagger.io/oauth/dialog","flow":"implicit","scopes":{"write:pets":"modify pets in your account","read:pets":"read your pets"}},"api_key":{"type":"apiKey","name":"api_key","in":"header"}},"definitions":{"User":{"type":"object","required":["username","email","password","gender","fullname","address","birthday"],"properties":{"email":{"type":"string","format":"email","example":"lvmtam@gmail.com"},"password":{"type":"string","minLength":8},"fullname":{"type":"string"},"gender":{"type":"integer","description":"0: Male, 1: Female","enum":[0,1]},"birthday":{"type":"string","format":"date-time"},"address":{"type":"string"},"phone":{"type":"string"},"avatar":{"type":"string","format":"binary"},"allowNotification":{"type":"boolean","default":true},"role":{"type":"integer","default":0,"enum":["0 (Standard user)","1 (Admin user)"]}}},"Category":{"type":"object","properties":{"id":{"type":"integer"},"title_en":{"type":"string"},"title_vi":{"type":"string"},"id_parrent":"type:integer","created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"Comment":{"type":"object","properties":{"id":{"type":"integer"},"user_id":{"type":"integer"},"content":{"type":"string","minLength":20},"rating":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"type":{"type":"integer","description":"0: For user, 1: For request","enum":[0,1]}}},"Mail":{"type":"object","properties":{"id":{"type":"integer"},"content":{"type":"string"},"from_user_id":{"type":"string"},"to_user_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"status":{"type":"integer","description":"0: Sent, 1: Seen","enum":[0,1]}}},"Notification":{"type":"object","properties":{"id":{"type":"int"},"owner_id":{"type":"integer"},"type":{"type":"integer"},"content_vi":{"type":"string"},"content_en":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}},"Request_Product":{"type":"object","properties":{"id":{"type":"iinteger"},"title_vi":{"type":"string"},"description_vi":{"type":"string"},"title_en":{"type":"string"},"description_en":{"type":"string"},"photos":{"type":"string"},"category_id":{"type":"integer"},"price_per_item":{"type":"integer"},"quantity":{"type":"integer"},"unit":{"type":"integer"},"currency":{"type":"int"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"status":{"type":"integer","description":"0: Inactive, 1: Active, -1: Deleted","enum":[0,1,-1]},"user_id":{"type":"integer"},"location":{"type":"string"},"info":{"type":"string","description":"key-value, key1-value1,..","example":"remote control-yes, screen-14inch,..."},"type":{"type":"integer","description":"0: Product, 1: Request","enum":[0,1]}}},"Order":{"type":"object","properties":{"id":{"type":"integer"},"order-address":{"type":"string"},"order-address_en":{"type":"string"},"status_last":{"type":"integer","description":"0: Wating, 1:Packaging, 2:Sent, 3: Success, 4: Cancel","enum":[0,1,2,3,4]},"ship-id":{"type":"integer"},"buyer-id":{"type":"integer"},"saller_id":{"type":"integer"},"payment_id":{"type":"integer"},"status_history":{"type":"integer"},"note":{"type":"string"},"note_en":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"Order_detail":{"type":"object","properties":{"id":{"type":"integer"},"order-id":{"type":"int"},"product_id":{"type":"integer"},"product-title":{"type":"string"},"product_price-per_item":{"type":"integer"},"product_curency":{"type":"integer"},"product_quantity_unit":{"type":"integer"},"product_info":{"type":"string"}}},"Ship_type":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"name_en":{"type":"string"},"description":{"type":"string"},"description_en":{"type":"string"}}},"Payment":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"name_en":{"type":"string"},"description":{"type":"string"},"description_en":{"type":"string"}}},"Unit":{"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"description_en":{"type":"string"}}},"Currency":{"type":"object","properties":{"id":{"type":"integer"},"code":{"type":"integer"},"description":{"type":"string"},"description_en":{"type":"string"}}},"OrderStatusHistory":{"type":"object","properties":{"order_id":{"type":"integer"},"status":{"type":"integer"},"update_time":{"type":"string","format":"date-time"},"note_en":{"type":"string"},"note":{"type":"string"}}},"PackageTransition":{"type":"object","properties":{"id":{"type":"integer"},"price":{"type":"integer"},"title":{"type":"string"},"count":{"type":"integer"},"note_en":{"type":"string"},"note":{"type":"string"}}},"UserPackageTransition":{"type":"object","properties":{"user_id":{"type":"integer"},"pakage_id":{"type":"integer"},"remain_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"}}}},"externalDocs":{"description":"Find out more about Swagger","url":"http://swagger.io"},"host":"virtserver.swaggerhub.com","basePath":"/ThangLe/a2z/1.0.0","schemes":["https","http"]}