Test Assignment for frontend developer API documentation version 1

https://test-assignment-api.goodsoft.com.ua

/token

get

get

Get token for user registration.

Method returns a token that is required to register a new user. The token is valid for 40 minutes and can be used for only one request. For the next registration, you will need to get a new one.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/token ```

Example curl sh:


```sh $curl https://test-assignment-api.goodsoft.com.ua/api/v1/token ```

Example javascript:


```js fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/token') .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); }) .catch(function(error) { // proccess network errors }); ```

/users

get post

get

Users pagination


Returns users data from a database divided into pages and sorted by ID in the ascending order. You can specify the parameters such as **count**, **offset** and **page**, which correspond to the number of users on the page, missing record number and page number. If you specify the **offset** parameter, the **page** parameter will be ignored.

To navigate through the pages, you can use the links in the server's response: next_link to go to the next page and prev_link to return to the previous page. If the next or previous page does not exist, the next_link/prev_link parameter will be set to null

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users?page=1&count=5 ```

Example curl sh:


```sh $curl https://test-assignment-api.goodsoft.com.ua/api/v1/users?page=1&count=5 ```

Example javascript:


```js fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/users?page=1&count=5') .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); if(data.success) { // process success response } else { // proccess server errors } }) ```
post

User registration request.


All fields are **required**
  • name - user name, should be 2-60 characters
  • email - user email, must be a valid email according to RFC2822
  • phone - user phone number, should start with code of Ukraine +380
  • position_id - user position id. You can get list of all positions with their IDs using the API method GET api/v1/positions
  • photo - user photo should be jpg/jpeg image, with resolution at least 70x70px and size must not exceed 5MB.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users ```

Example curl sh:


```sh $curl --form "[email protected]/photo.jpg;" \ --form name=Jhon \ --form [email protected] \ --form phone=+380955388485 \ --form position_id=2 \ https://test-assignment-api.goodsoft.com.ua/api/v1/users ```

Example javascript:


```js var formData = new FormData(); // file from input type='file' var fileField = document.querySelector('input[type="file"]'); formData.append('position_id', 2); formData.append('name', 'Jhon'); formData.append('email', '[email protected]'); formData.append('phone', '+380955388485'); formData.append('photo', fileField.files[0]);

fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/users', { method: 'POST', body: formData, headers: { 'Token': token, // get token with GET api/v1/token method }, }) .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); if(data.success) { // process success response } else { // proccess server errors } }) .catch(function(error) { // proccess network errors });

User registration request.


All fields are **required**
  • name - user name, should be 2-60 characters
  • email - user email, must be a valid email according to RFC2822
  • phone - user phone number, should start with code of Ukraine +380
  • position_id - user position id. You can get list of all positions with their IDs using the API method GET api/v1/positions
  • photo - user photo should be jpg/jpeg image, with resolution at least 70x70px and size must not exceed 5MB.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users ```

Example curl sh:


```sh $curl --form "[email protected]/photo.jpg;" \ --form name=Jhon \ --form [email protected] \ --form phone=+380955388485 \ --form position_id=2 \ https://test-assignment-api.goodsoft.com.ua/api/v1/users ```

Example javascript:


```js var formData = new FormData(); // file from input type='file' var fileField = document.querySelector('input[type="file"]'); formData.append('position_id', 2); formData.append('name', 'Jhon'); formData.append('email', '[email protected]'); formData.append('phone', '+380955388485'); formData.append('photo', fileField.files[0]);

fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/users', { method: 'POST', body: formData, headers: { 'Token': token, // get token with GET api/v1/token method }, }) .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); if(data.success) { // process success response } else { // proccess server errors } }) .catch(function(error) { // proccess network errors });

Headers

  • Token: required(string)

    Token

    Example:

    eyJpdiI6Im9mV1NTMlFZQTlJeWlLQ3liVks1MGc9PSIsInZhbHVlIjoiRTJBbUR4dHp1dWJ3ekQ4bG85WVZya3ZpRGlMQ0g5ZHk4M05UNUY4Rmd3eFM3czc2UDRBR0E4SDR5WXlVTG5DUDdSRTJTMU1KQ2lUQmVZYXZZOHJJUVE9PSIsIm1hYyI6ImE5YmNiODljZjMzMTdmMDc4NjEwN2RjZTVkNzBmMWI0ZDQyN2YzODI5YjQxMzE4MWY0MmY0ZTQ1OGY4NTkyNWQifQ==

Body

Media type: multipart/form-data

Type: object

Properties
  • name: required(string - minLength: 2 - maxLength: 60)

    Username should contain 2-60 characters

    Example:

    Jhon
  • email: required(string - minLength: 2 - maxLength: 100 - pattern: ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$)

    User email, must be a valid email according to RFC2822

    Example:

    [email protected]
  • phone: required(string - pattern: ^[\+]{0,1}380([0-9]{9})$)

    User phone number. Number should start with code of Ukraine +380

    Example:

    +380955388485
  • position_id: required(integer - minimum: 1)

    User`s position id. You can get list of all positions with their IDs using the API method GET api/v1/positions

    Example:

    3
  • photo: required(file)

    Minimum size of photo 70x70px. The photo format must be jpeg/jpg type. The photo size must not be greater than 5 Mb.

HTTP status code 200

Body

Media type: application/json

Example:

{
  "success" : true,
  "user_id" : 23,
  "message" : "New user successfully registered"
}

HTTP status code 401

Body

Media type: application/json

Example:

{
    "success": false,
    "message": "The token expired."
}

HTTP status code 409

Body

Media type: application/json

Example:

{
  "success": false,
  "message": "User with this phone or email already exist"
}

HTTP status code 422

Body

Media type: application/json

Example:

{
    "success": false,
    "message": "Validation failed",
    "fails": {
        "name": [
            "The name must be at least 2 characters."
        ],
        "email": [
            "The email must be a valid email address."
        ],
        "phone": [
            "The phone field is required."
        ],
        "position_id": [
            "The position id must be an integer."
        ],
        "photo": [
            "The photo may not be greater than 5 Mbytes.",
            "Image is invalid."
        ]
    }
}

/users/{id}

get

get

##Get user by id Return information about user by his id. This method can be used to obtain a specific user for the site header.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users/1 ```

Example curl sh:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users/1 ```

Example javascript:


```js fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/users/1') .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); if(data.success) { // process success response } else { // proccess server errors } }) ```

##Get user by id Return information about user by his id. This method can be used to obtain a specific user for the site header.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users/1 ```

Example curl sh:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/users/1 ```

Example javascript:


```js fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/users/1') .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); if(data.success) { // process success response } else { // proccess server errors } }) ```

URI Parameters

  • id: required(integer)

    The id of the user

    Example:

    1

HTTP status code 200

Body

Media type: application/json

Example:

{
    "success": true,
    "user": {
        "id": 1,
        "name": "Superstar",
        "email": "[email protected]",
        "phone": "+380957398462",
        "position": "Security",
        "position_id": 2,
        "photo": "https://test-assignment-api.goodsoft.com.ua/images/users/5b9626f0157d224.jpeg"
    }
}

HTTP status code 400

Body

Media type: application/json

Example:

{
  "success": false,
  "message": "Validation failed",
  "fails": {
        "user_id": [
            "The user_id must be an integer."
        ]
    }
}

HTTP status code 404

Body

Media type: application/json

Example:

{
    "success": false,
    "message": "The user with the requested identifier does not exist",
    "fails": {
      "user_id" : [
        "User not found"
      ]
    }
}

/positions

get

get

Get users positions

Returns a list of all available users positions.

Example of method url:


```sh https://test-assignment-api.goodsoft.com.ua/api/v1/positions ```

Example curl sh:


```sh $curl https://test-assignment-api.goodsoft.com.ua/api/v1/positions ``` ### Example javascript:
```js fetch('https://test-assignment-api.goodsoft.com.ua/api/v1/positions') .then(function(response) { return response.json(); }) .then(function(data) { console.log(data); // process success response }) ```