Partners

Partner

Partner is an special kind of User which manages event, provides tickets and sign contracts with others. It’s different since in most cases single Partner represents some organization which may be managed by multiple different users. People come and gone, partners are more persistent thing in the world.

GET /v1/resources/partners/{idpartner}

Returns partner information.

Request Headers:  

• Accept – application/json

Parameters:

• idpartner (string) – Partner ID

Query Parameters:  

• fields-schema (string) – Fields Schema DSL

Response Headers:  

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

Response JSON Object:  

• channels (string) – Partner creation timestamp
• contact (object) – Contact information
• created_at (datetime) – Partner creation timestamp
• desc (string) – Description
• director (string) – CEO
• id (string) – Partner ID
• legal (object) – Related Legal
• name (string) – Partner name
• media (array) – Media files
• removed (boolean) – Deleted flag
• roles (array) – Assigned roles
• tags (array) – Tags
• updated_at (datetime) – Partner update timestamp

Status Codes:

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

Request:

GET /v1/resources/partners/535fb19bdca6a9d1638f2007 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

{
    "channels": "Все доступные каналы распространения",
    "contact": {
        "address": "г.Москва, ул. Берсеневский переулок, 2с1",
        "email": "info@nanobilet.ru",
        "id": null,
        "phones": ["+79101002030"],
        "www": "http://nanobilet.ru"
    },
    "created_at": null,
    "desc": "Первый агент системы",
    "director": "Егор Егерев",
    "id": "535fb19bdca6a9d1638f2007",
    "legal": null,
    "name": "Nanobilet",
    "removed": false,
    "roles": ["agent"],
    "tags": ["музыка", "вечеринки", "концерты"],
    "updated_at": null,
    "user": {
        "created_at": null,
        "email": "ag@tc.ru",
        "first_name": "Егор",
        "id": "535fb11ddca6a9d1638f2006",
        "last_name": "Егерев",
        "partners": ["535fb19bdca6a9d1638f2007"],
        "tags": [],
        "updated_at": null
    }
}

PATCH /v1/resources/partners/{idpartner}

Updates specific partner fields.

Request Headers:  

• Accept – application/json

Parameters:

• idpartner (string) – Partner ID

Query Parameters:  

• fields-schema (string) – Fields Schema DSL

Request JSON Object:  

• channels (string) – Partner creation timestamp
• contact (object) – Contact information
• desc (string) – Description
• director (string) – CEO
• legal (object) – Related Legal
• name (string) – Partner name
• media (array) – Media files
• removed (boolean) – Deleted flag
• roles (array) – Assigned roles
• tags (array) – Tags
• updated_at (datetime) – Partner update timestamp

Response Headers:  

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

Response JSON Object:  

• channels (string) – Partner creation timestamp
• contact (object) – Contact information
• created_at (datetime) – Partner creation timestamp
• desc (string) – Description
• director (string) – CEO
• id (string) – Partner ID
• legal (object) – Related Legal
• media (array) – Media files
• name (string) – Partner name
• removed (boolean) – Deleted flag
• roles (array) – Assigned roles
• tags (array) – Tags
• updated_at (datetime) – Partner update timestamp

Status Codes:

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

Partners

Collection of Partner objects.

GET /v1/resources/partners

Returns list of Partner objects.

Request Headers:  

• Accept – application/json

Query Parameters:  

• ids (string) – List of IDs to return
• fields-schema (string) – Fields Schema DSL

Response Headers:  

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

Response JSON Object:  

• channels (string) – Partner creation timestamp
• contact (object) – Contact information
• created_at (datetime) – Partner creation timestamp
• desc (string) – Description
• director (string) – CEO
• id (string) – Partner ID
• legal (object) – Related Legal
• media (array) – Media files
• name (string) – Partner name
• removed (boolean) – Deleted flag
• roles (array) – Assigned roles
• tags (array) – Tags
• updated_at (datetime) – Partner update timestamp

Status Codes:

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

Request:

GET /v1/resources/partners 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

[
    {
        "channels": null,
        "contact": {},
        "created_at": null,
        "desc": null,
        "director": null,
        "id": "5357b929f51600525c9e1396",
        "legal": null,
        "name": "Organizator",
        "removed": false,
        "roles": ["org"],
        "tags": [],
        "updated_at": null,
        "user": {
            "created_at": null,
            "email": "org@tc.ru",
            "first_name": "Org",
            "id": "53555b2256c02c17cb75791c",
            "last_name": "Organizator",
            "partners": ["5357b929f51600525c9e1396"],
            "tags": [],
            "updated_at": null
        }
    },
    {
        "channels": "Все доступные каналы распространения",
        "contact": {
            "address": "г.Москва, ул. Берсеневский переулок, 2с1",
            "email": "info@nanobilet.ru",
            "id": null,
            "phones": ["+79101002030"],
            "www": "http://nanobilet.ru"
        },
        "created_at": null,
        "desc": "Первый агент системы",
        "director": "Егор Егерев",
        "id": "535fb19bdca6a9d1638f2007",
        "legal": null,
        "name": "Nanobilet",
        "removed": false,
        "roles": ["agent"],
        "tags": ["музыка", "вечеринки", "концерты"],
        "updated_at": null,
        "user": {
            "created_at": null,
            "email": "ag@tc.ru",
            "first_name": "Егор",
            "id": "535fb11ddca6a9d1638f2006",
            "last_name": "Егерев",
            "partners": ["535fb19bdca6a9d1638f2007"],
            "tags": [],
            "updated_at": null
        }
    }
]