GET /user

Get a list of available users. Users can also be browsed by keywords, gender, age, and other profile fields

Example URI

 http://example.com/restful_api/user?page=1&limit=10

Parameters

Parameter

Type

Require ?

Description

page

number

no

Paging the result items

limit

number

no

Limit the result items

view

string

no

Options: recommend, recent

searchgender

number

no

Specify the gender of searching users (gender id)

searchfrom

number

no

Specify the minimum age of searching users

searchto

number

no

Specify the maximum age of searching users

searchcountry

string

no

Specify the country of searching users (country code)

searchcountry_child_id

number

no

Specify the state/province of searching users (state id/ province id)

searchzip

string

no

Specify the zip code of searching users

searchcity

string

no

Specify the city of searching users

searchkeyword

string

no

Search for users that contains this keyword in their name

custom

array

no

Specify custom fields of searching users

Response

{
  "status": "success",
  "data": [
    {
      "is_friend": null,
      "is_friend_request": null,
      "user_id": "1",
      "user_name": "admin",
      "full_name": "Admin",
      "user_image": "2016/12/07140d52d833bb6c304ee1f48bbe623f%s.png"
    },
    {
      "is_friend": "1",
      "is_friend_request": null,
      "user_id": "2",
      "user_name": "neil",
      "full_name": "Neil",
      "user_image": null
    }
  ],
  "messages": []
}

POST /user

Register a user account

Example URI

 http://example.com/restful_api/user

Parameters

Input fields base on site settings

Response

{
  "status": "success",
  "data": {
    "cover_photo_exists": null,
    "user_id": "7",
    "user_group_id": "2",
    "user_name": "profile-7",
    "full_name": "Vivian",
    "email": "vivian@example.com",
    "gender": "0",
    "birthday": null,
    "birthday_search": "0",
    "country_iso": null,
    "language_id": null,
    "time_zone": null,
    "user_image": null,
    "is_online": null,
    "title": "Registered User",
    "is_friend": false,
    "is_friend_of_friend": false,
    "is_friend_request": false,
    "relation_id": null,
    "relation_with_id": null,
    "relation_phrase": null
  },
  "messages": [
    "User successfully added."
  ]
}

GET /user/:id

Get information of a specific user by user id

Example URI

 http://example.com/restful_api/user/1

Parameters

Parameter

Type

Require ?

Description

id

number

yes

User id

Response

{
  "status": "success",
  "data": {
    "cover_photo_exists": "6",
    "user_id": "1",
    "user_group_id": "1",
    "user_name": "admin",
    "full_name": "Admin",
    "email": "robert@example.com",
    "gender": "3",
    "birthday": "05091988",
    "birthday_search": "579139200",
    "country_iso": "US",
    "language_id": "en",
    "time_zone": "z357",
    "user_image": "2016/12/07140d52d833bb6c304ee1f48bbe623f%s.png",
    "is_online": "1",
    "title": "Administrator",
    "is_friend": false,
    "is_friend_of_friend": false,
    "is_friend_request": false,
    "relation_id": "2",
    "relation_with_id": "0",
    "relation_phrase": "Single"
  },
  "messages": []
}

PUT /user/:id

Update a specific user

Example URI

 http://example.com/restful_api/user/1

Parameters

Parameter

Type

Require ?

Description

id

number

yes

User Id

val[email]

string

no

Email address

val[user_name]

string

no

User name

val[full_name]

string

no

Full name

val[language_id]

string

no

Language id

val[time_zone]

string

no

Timezone id

val[default_currency]

string

no

Default currency

val[city_location]

string

no

City location

val[country_iso]

string

no

Country iso

val[day]

number

no

Day of birth

val[month]

number

no

Month of birth

val[year]

number

no

Year of birth

val[gender]

number

no

Gender id

val[country_child_id]

number

no

State id or province id

val[postal_code]

string

no

Postal code

val[relation]

number

no

Relation id

val[relation_with]

number

no

Id of user that have relation with this user

val[password]

string

no

Update password

val[delete_image]

number

no

Delete profile photo or not

image

image file

no

Upload profile photo

Response

{
  "status": "success",
  "data": {
    "cover_photo_exists": null,
    "user_id": "7",
    "user_group_id": "2",
    "user_name": "profile-7",
    "full_name": "Vivian",
    "email": "vivian@phpfox.com",
    "gender": "0",
    "birthday": null,
    "birthday_search": "0",
    "country_iso": null,
    "language_id": null,
    "time_zone": null,
    "user_image": null,
    "is_online": null,
    "title": "Registered User",
    "is_friend": false,
    "is_friend_of_friend": false,
    "is_friend_request": false,
    "relation_id": null,
    "relation_with_id": null,
    "relation_phrase": null
  },
  "messages": [
    "User successfully added."
  ]
}

DELETE /user/:id

Delete a specific user

Example URI

 http://example.com/restful_api/user/2

Parameters

Parameter

Type

Require ?

Description

id

number

yes

User id

Response

{
  "status": "success",
  "data": [],
  "messages": [
    "User successfully deleted."
  ]
}

GET /user/custom/:id

Get custom fields information of a specific user by user id

Example URI

 http://example.com/restful_api/user/custom/1

Parameters

Parameter

Type

Require ?

Description

id

number

yes

User id

Response

{
  "status": "success",
  "data": [
    {
      "field_id": "2",
      "field_name": "job",
      "field_label": "Job",
      "var_type": "select",
      "value": "Back-end Developer",
      "custom_value": "1",
      "group_id": "2",
      "group_label": "Personal Information"
    },
    {
      "field_id": "3",
      "field_name": "hobbies_and_interest",
      "field_label": "hobbies and interests:",
      "var_type": "text",
      "value": "Reading books, traveling, cooking...",
      "custom_value": "",
      "group_id": "2",
      "group_label": "Personal Information"
    },
    {
      "field_id": "1",
      "field_name": "about_me",
      "field_label": "About Me",
      "var_type": "textarea",
      "value": "I'm a good guy :)",
      "custom_value": "",
      "group_id": "1",
      "group_label": "About Me"
    }
  ],
  "messages": []
}

PUT /user/custom/:id

Update custom fields values of a specific user

Example URI

 http://example.com/restful_api/user/custom/1

Parameters

Parameter

Type

Require ?

Description

id

number

yes

User Id

custom

array

no

Custom fields values

Response

{
  "status": "success",
  "data": [
    {
      "field_id": "3",
      "field_name": "hobbies_and_interest",
      "field_label": "hobbies and interests:",
      "var_type": "text",
      "value": "Reading books, traveling, cooking...",
      "custom_value": "",
      "group_id": "2",
      "group_label": "Personal Information"
    },
    {
      "field_id": "2",
      "field_name": "job",
      "field_label": "Job",
      "var_type": "select",
      "value": "Back-end Developer",
      "custom_value": "1",
      "group_id": "2",
      "group_label": "Personal Information"
    },
    {
      "field_id": "1",
      "field_name": "about_me",
      "field_label": "About Me",
      "var_type": "textarea",
      "value": "I'm a good guy :)",
      "custom_value": "",
      "group_id": "1",
      "group_label": "About Me"
    }
  ],
  "messages": [
    "Custom fields successfully updated."
  ]
}