vago-models

Important Note: every failed/bad request will response models/common/CommonResponse

Auth

Login:

Request: models/auth/LoginRequest Response: models/auth/LoginResponse

Register:

Request: models/auth/LoginRequest Response: models/common/CommonResponse

Request reset password:

Request: models/auth/RequestResetPasswordRequest Response: models/common/CommonResponse

Reset password:

Request: models/auth/ResetPasswordRequest Response: models/common/CommonResponse

Refresh token:

Request: models/auth/RefreshTokenRequest Response: models/auth/RefreshTokenResponse

Countries

List available contries:

Request: no filters Response: models/contries/Country

Get by id:

Request: (GET param) country_id: number Response: models/contries/Country

Favorites

List my favorites places (full info):

Request: no filters Response: PaginatedItems< FavoritePlace >

List my favorites places (basic info):

Request: no filters Response: PaginatedItems< FavoritePlaceBasic >

List my favorites places (min info):

Request: no filters Response: PaginatedItems< FavoritePlaceMin >

Set place as favorite (or remove as favorite):

Request: models/favorites/SetFavoritePlaceRequest Response: CommonResponse< any >

Check if place is favorite:

Request: (GET param) place_id: number Response: models/favorites/CheckIfFavoriteResponse (message: boolean)

Places

Create place:

Request: body -> placeRegisterRequest: models/places/CreateRequestBody Response: CommonResponse<{id: number}>

Get by id:

Request: (GET param) place_id: number Response: models/places/Place

List places (full info):

Request: (GET params) country_id: number [mandatory], type: enums/PlaceType [optional], keyword: string [optional], page: number [optional defualt=1], limit: number [optional default=10] Response: PaginatedItems< Place >

List places (basic info):

Request: (GET params) country_id: number [mandatory], type: enums/PlaceType [optional], keyword: string [optional], page: number [optional defualt=1], limit: number [optional default=10] Response: PaginatedItems< PlaceBasic >

List places (min info):

Request: (GET params) country_id: number [mandatory], type: enums/PlaceType [optional], keyword: string [optional], page: number [optional defualt=1], limit: number [optional default=10] Response: PaginatedItems< PlaceMin >

List places types:

Request: no filters Response: models/places/PlaceTypesResponse

Reviews

Create review:

Request: models/reviews/CreateReviewRequest Response: CommonResponse< {id: number} >

Edit review:

Request: models/reviews/EditReviewRequest (GET param) /:review_id Response: CommonResponse< any >

Delete review:

Request: (GET param) /:review_id Response: CommonResponse< any >

Get by place id:

Request: (GET param) place_id: number Response: PaginatedItems< PlaceReviewItem >

Get by user id:

Request: (GET param) user_id: number Response: PaginatedItems< UserReviewItem >

Users

Change user photo:

Request: (Form data para): files Response: CommonResponse< any >

Get my user info:

Request: no filters Response: models/users/User

Get another user info:

Request: (GET param) /:user_id Response: models/users/User

Update user info:

Request: models/user/UpdateUserInfoRequest Response: CommonResponse< any >

Admin

Places

Set enabled:

Request: models/common/CommonSetStateRequest Response: CommonResponse< any >

Set visible:

Request: models/common/CommonSetStateRequest Response: CommonResponse< any >

Reviews

Set enabled:

Request: models/common/CommonSetStateRequest Response: CommonResponse< any >

Set visible:

Request: models/common/CommonSetStateRequest Response: CommonResponse< any >

Users

Set enabled:

Request: models/common/CommonSetStateRequest Response: CommonResponse< any >