Properties of a REST API method document

Purpose

This service should be used for internal services/processes. Used without access_token

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

See on API-specification

{
  "password": "qwerty"
}

Headers

Headers

Request data validation

Authorize

Used without access_token

If client knows the employee_request_ID he can create user and approve it.

Processing

Get Employee Request Details

Invoke WS Get Employee Request by ID for further employee creation

 See service specification

Sample Request

curl -X GET -H 'Content-Type: application/json' 'http://ehealth.nebo15.com/employee_requests/d290f1ee-6c54-4b01-90e6-d701748f0851'

...

    else return Error 401

Create user in oAuth

System should create user in oAuth by using Create User WS

...

See service specification

Response structure examples

See on API-specification

{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "email": "john@example.com",
    "settings": {},
    "priv_settings": {},
    "id": "user-1380df72-275a-11e7-93ae-92361f002671",
    "created_at": "2017-04-20T19:14:13Z",
    "updated_at": "2017-04-20T19:14:13Z"
  }
}

HTTP status codes

Post-processing processes

Technical modules where the method is used

...