Users

User

Users are represents the humans which works with TicketsCloud API: each has own credentials and association. Users can only update their information, create related partners and their keys.

GET /v1/resources/users/{user_id}

Returns information about user by the specified ID.

Request Headers:  

• Accept – application/json

Parameters:

• user_id (string) – User ID

Query Parameters:  

• fields-schema (string) – Fields Schema DSL

Response Headers:  

• Content-Type – application/json
• Transfer-Encoding – chunked

Response JSON Object:  

• created_at (datetime) – User creation timestamp
• email (string) – User email address
• first_name (string) – User first name
• id (string) – User unique ID
• last_name – User last name
• partners (array) – List of the Partners which users may operate with
• tags (array) – List of the associated tags
• updated_at (datetime) – User update timestamp
• crm (object) –

  CRM cpecified info:

  • values orders values info:

    • avg
    • sum

  • counters some counters:

    • orders
    • tickets

Status Codes:

• 200 OK – Ok
• 400 Bad Request – Invalid request parameters
• 401 Unauthorized – Authentication required
• 403 Forbidden – Operation not allowed

Request:

GET /v1/resources/users/53e241d137abbd588116ef3e HTTP/1.1
Accept: application/json
Host: ticketscloud.org

Response:

HTTP/1.1 200 Ok
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

{
    "created_at": "2014-08-06T14:55:13.601000+00:00",
    "email": "user@domain.ltd",
    "first_name": null,
    "id": "53e241d137abbd588116ef3e",
    "last_name": null,
    "partners": [],
    "tags": [],
    "updated_at": "2014-08-06T14:55:13.601000+00:00",
    "crm": {
        "values": {
            "avg": "1000.00",
            "sum": "2000.00"
        },
        "counters": {
            "orders": 2,
            "tickets": 4
        }
    }
}

PATCH /v1/resources/users/{user_id}

Updates user information.

Request Headers:  

• Accept – application/json

Parameters:

• user_id (string) – User ID

Query Parameters:  

• fields-schema (string) – Fields Schema DSL

Request JSON Object:  

• email (string) – User email address
• first_name (string) – User first name
• last_name – User last name
• password – New password

Response Headers:  

• Content-Type – application/json
• Transfer-Encoding – chunked

Response JSON Object:  

• created_at (datetime) – User creation timestamp
• email (string) – User email address
• first_name (string) – User first name
• id (string) – User unique ID
• last_name – User last name
• partners (array) – List of the Partners which users may operate with
• tags (array) – List of the associated tags
• updated_at (datetime) – User update timestamp

Status Codes:

• 200 OK – Ok
• 400 Bad Request – Invalid request parameters
• 401 Unauthorized – Authentication required
• 403 Forbidden – Operation not allowed

Request:

PATCH /v1/resources/users/53da11a537abbd06b21cb254 HTTP/1.1
Accept: application/json
Content-Length: 45
Cookie: auth_tkt="FiYmQwNmIyMWNiMjU0!userid_type:b64unicode"; Domain=ticketscloud.org; Path=/
Host: ticketscloud.org

{"last_name": "Smith", "first_name": "John"}

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

{
    "created_at": "2014-07-31T09:51:33.363000+00:00",
    "email": "user@domain.tld",
    "first_name": "John",
    "id": "53da11a537abbd06b21cb254",
    "last_name": "Smith",
    "partners": [],
    "tags": [],
    "updated_at": "2014-07-31T09:51:33.363000+00:00"
}

Users

Collection of User objects.

GET /v1/resources/users

Returns list of users.

Request Headers:  

• Accept – application/json

Query Parameters:  

• fields-schema (string) – Fields Schema DSL
• suggest (string) – filter user on suggest
• order_event (string) – event id
• order_status (string) – order status filter (require order_event)
• page (int) – page number
• page-size (int) – number items on page
• sort (str) – one of email, -email, suggest, -suggest

Response Headers:  

• Content-Type – application/json
• Transfer-Encoding – chunked
• TOTAL – total found users (for pagination)

Response JSON Array of Objects:  

• id (string) – User unique ID
• created_at (datetime) – User creation timestamp
• email (string) – User email address
• first_name (string) – User first name
• last_name (string) – User last name
• partners (array) – List of the Partners which users may operate with
• tags (array) – List of the associated tags
• updated_at (datetime) – User update timestamp

Response JSON Object:  

• crm (object) –

  CRM cpecified info:

  • values orders values info:

    • avg
    • sum

  • counters some counters:

    • orders
    • tickets

Status Codes:

• 200 OK – Ok
• 400 Bad Request – Invalid request parameters
• 401 Unauthorized – Authentication required
• 403 Forbidden – Operation not allowed

Request:

GET /v1/resources/users HTTP/1.1
Accept: application/json
Host: ticketscloud.org

Response:

HTTP/1.1 201 Created
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

[
    {
        "created_at": "2014-08-06T14:55:13.601000+00:00",
        "email": "user@domain.ltd",
        "first_name": null,
        "id": "53e241d137abbd588116ef3e",
        "last_name": null,
        "partners": [],
        "tags": [],
        "updated_at": "2014-08-06T14:55:13.601000+00:00"
        "crm": {
            "values": {
                "avg": "1000.00",
                "sum": "2000.00"
            },
            "counters": {
                "orders": 2,
                "tickets": 4
            }
        }
    },
    {
        "created_at": "2014-08-06T14:56:46.465000+00:00",
        "email": "user@domain.com",
        "first_name": null,
        "id": "53e2422e37abbd588116ef3f",
        "last_name": null,
        "partners": [],
        "tags": [],
        "updated_at": "2014-08-06T14:56:46.465000+00:00"
        "crm": {
            "values": {
                "avg": "1000.00",
                "sum": "2000.00"
            },
            "counters": {
                "orders": 2,
                "tickets": 4
            }
        }
    }
]

POST /v1/resources/users

Registers a new user.

Request Headers:  

• Accept – application/json
• Content-Type – application/json

Query Parameters:  

• fields-schema (string) – Fields Schema DSL

Request JSON Object:  

• email (string) – User email
• password (string) – User password

Response Headers:  

• Content-Type – application/json

Response JSON Object:  

• created_at (datetime) – User creation timestamp
• email (string) – User email address
• id (string) – User unique ID
• partners (array) – List of the Partners which users may operate with
• tags (array) – List of the associated tags
• updated_at (datetime) – User update timestamp

Status Codes:

• 201 Created – User have been created
• 400 Bad Request – Invalid request parameters
• 401 Unauthorized – Authentication required
• 403 Forbidden – Operation not allowed

Request:

POST /v1/resources/users HTTP/1.1
Accept: application/json
Content-Length: 48
Host: ticketscloud.org

{
    "email": "user@domain.tld",
    "password": "s3cr1t"
}

Response:

HTTP/1.1 201 Created
Content-Length: 190
Content-Type: application/json; charset=UTF-8

{
    "created_at": "2014-08-06T14:59:20.323853+00:00",
    "email": "user@domain.tld",
    "id": "53e242c837abbd588116ef41",
    "partners": [],
    "tags": [],
    "updated_at": "2014-08-06T14:59:20.323853+00:00"
}

GET /v1/resources/users/:id/orders

Request Headers:  

• Accept – application/json
• Content-Type – application/json

Query Parameters:  

• fields-schema (string) – Fields Schema DSL
• event (string) – event id
• status (string) – filter on order status

Status Codes:

• 200 OK – Ok
• 400 Bad Request – Invalid request parameters

Return list of orders objects.