Users API Demo

• chrome_reader_mode API Demos
• live_help API Documentation
• assessment Unit Tests
• dns Utilities

API Documentation

List of the all available calls and the expected data to be sent and received. All of the data must be sent via the POST protocol.

[
    "user" => [
        "email" => "your@email.com",
        "given_name" => "John",
        "family_name" => "Smith"
    ]
]

{
    user: {
        email: "your@email.com",
        given_name: "John",
        family_name: "Smith"
    }
}

{
   type: "success",
   message: "Created new user with ID: ?"
}

[
    "email" => "your@email.com"
]

{
    email: "your@email.com"
}

{
   type: "success",
   message: "User found!",
   data: {
      id: "1",
      email: "your@email.com",
      givenName: "John",
      familyName: "Smith",
      created: "2018-12-16 07:49:49"
   }
}

[
    "user" => [
        "id" => 1,
        "given_name" => "John",
        "family_name" => "Smith"
    ]
]

{
    user: {
        id: 1,
        given_name: "John",
        family_name: "Smith"
    }
}

{
   type: "success",
   message: "Updated existing user with ID: 1"
}

[
    "user_id" => 1
]

{
    user_id: 1
}

{
   type: "success",
   message: "Deleted existing user with ID: 1"
}

LIST

Read user's list from the database. As a option you can determine the start position of the listing, and the limit of the results.
Both parameters (`start`, and `limit`) are optional, and they accept "0" as a parameter too.
url: http://demo-users-api.goldenorbs.com/api/list

[
    "start" => 0,
    "limit" => 2,
]

{
    start: 0,
    limit: 2
}

[
    {
        id: 1,
        email: "your@email.com",
        givenName: "John",
        familyName: "Smith",
        created: "2018-12-16 09:39:30"
    },
    {
        id: 1,
        email: "another@email.com",
        givenName: "Jenny",
        familyName: "Jones",
        created: "2018-12-16 11:01:00"
    },
]