users.md

Users

---

Retrieve all users

api.ayat.com/v1/users GET

Payload:

{
    "jwt": "65416584846465644546"
}

Success Response:

code : 200

{
    "users": [...] 
}

Error Response:

code: 403

{
  "error": "user is unauthorized"
}

---

Retrieve a user

api.ayat.com/v1/users/{id} GET

Payload:

{
    "jwt": "65416584846465644546",
    "public_id": "123123
}

Success Response:

code : 200

{
    //user data.
}

Error Response:

code: 403

{
  "error": "user is unauthorized"
}

---

Login

api.ayat.com/v1/users POST

Payload:

{
    "action":   "login",
    "email": "example@gmail.com",
    "password": "123456",
}

Success Response:

code : 200

{
    "jwt": "65416584846465644546",
    "public_id": "123123"
    //other user data.
}

Error Response:

code: 403

{
  "error": "user is unauthorized"
}

---

Create a new (inactive) user

api.ayat.com/v1/users POST

Payload:

{
    "action":   "register",
    "user_id":  "example",
    "full_name":  "example",
    "email":  "example",
    "country":  "example",
    "phone":  61111,
    "profile_pic": "https://ayatsource.com/default.png",
    "birth_date":   "date",
    "gender":   "male",
    "password":   "464468",
    "registeration_date":   "20/2/2020"
}

Success Response:

code : 200

{
    "status":  "created"
}

or

{
    "status":  "<Duplicate resource codes> "
}

---

Update user data

api.ayat.com/v1/users/{id} PUT

Payload:

{
    "jwt":   "ffff",
    "email":  "example",
    "country":  "example",
    "phone":  61111,
    "profile_pic": "https://ayatsource.com/default.png",
    "birth_date":   "date",
    "password":   "464468"
}

Success Response:

code 200

{
    "status":  "updated"
}

or

{
    "status":  "<Duplicate resource codes>"
}

---

Delete a user

api.ayat.com/v1/users/{id} DELETE

Payload:

{
    "jwt":   "ffff"
}

Success Response:

code 200

{
    "status":  "deleted"
}