DEPRECATED - Recuperar contactos del usuario

Versión documento: v1

Creación: 24/06/2019

Última modificación: 17/08/2020

Contactos del usuario

Se obtienen los contactos del usuario solicitado, es decir, los usuarios que se encuentran en su misma organización.

También se devuelven los contactos favoritos del usuario.

Recuperar contactos del usuario

Intenta recuperar los contactos del usuario. Se puede enviar una fecha, en milisegundos, de última actualización de los contactos para evitar descargarlos si no ha habido cambios.

También se devuelve una lista con los contactos favoritos de los usuarios. Esta lista se devuelve siempre independientemente de la fecha de versión que se envíe.

Request

HTTP request

GET /api/v1/users/me/contacts
GET /api/v1/users/{userId}/contacts

Headers

Header	Value	Required
Authorization	Bearer eyJ0eXBlIjoiSldUIiwiYWxnIjoiSFM1MT…	true

Params

Param	Value	Required
contactsDate	Long - Fecha de última versión en milisegundos.	false

Response

Si se ha conseguido validar que el usuario tiene acceso para realizar la petición, se devuelve un código 200 con los contactos del usuario, en el cuerpo de la respuesta.

{
    "favoriteContacts": [],
    "contactsDate": 1590052390000,
    "contacts": [
        {
            "id": "304a9cba-ad72-49a1-8782-9ac9a36cd8e7",
            "name": "Aitor",
            "surname": "Jupiter",
            "alias": "072919a68fbd42aead115dbee1b02620",
            "email": "aitor.jupiter@bookker.es",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "304a9cba-ad72-49a1-8782-9ac9a36cd8e7"
            },
            "mobileRole": {
                "id": "5220b6a2-8920-4dae-8ff0-ba96707d439d"
            },
            "canBeSearched": false,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "3f45617f-2d97-42c4-8e19-1d7b8905e139",
            "name": "Ricardo",
            "surname": "Jupiter",
            "alias": "f05da4e525864addac199be1d7234eec",
            "email": "ricardo.jupiter@bookker.es",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "3f45617f-2d97-42c4-8e19-1d7b8905e139"
            },
            "mobileRole": {
                "id": "5220b6a2-8920-4dae-8ff0-ba96707d439d"
            },
            "canBeSearched": false,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "555d6938-aaf0-4959-add4-19dad63612c4",
            "name": "David",
            "surname": "Jupiter",
            "alias": "f297f30fd08b48869a59fd724122695a",
            "email": "david.jupiter@bookker.es",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "555d6938-aaf0-4959-add4-19dad63612c4"
            },
            "mobileRole": {
                "id": "1dfde059-da65-49c9-8db3-dccc4f3292e4"
            },
            "canBeSearched": true,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "6753b4d0-a237-41d6-bf1a-30efcc61cc8e",
            "name": "Miguel",
            "surname": "Jupiter",
            "alias": "9a7c637b14a14a17805bdceb2a2766a3",
            "email": "miguel.jupiter@bookker.es",
            "phone": "",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "6753b4d0-a237-41d6-bf1a-30efcc61cc8e"
            },
            "mobileRole": {
                "id": "1dfde059-da65-49c9-8db3-dccc4f3292e4"
            },
            "canBeSearched": false,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "6d8ca138-5015-4f5e-af20-f08eb9e3ef5b",
            "name": "xwing@wars.com",
            "surname": "-",
            "alias": "f9676767-e31a-49c3-b455-aa72c8cabd3f",
            "email": "xwing@wars.com",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "6d8ca138-5015-4f5e-af20-f08eb9e3ef5b"
            },
            "mobileRole": {},
            "canBeSearched": false,
            "type": "BOOKKER_EXTERNAL"
        },
        {
            "id": "71ebe9df-64db-494d-9213-19cc1613e3c8",
            "name": "Cesar",
            "surname": "Jupiter",
            "alias": "477a02927822402093de4a535c84e32b",
            "email": "cesar.jupiter@bookker.es",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "71ebe9df-64db-494d-9213-19cc1613e3c8"
            },
            "mobileRole": {
                "id": "1dfde059-da65-49c9-8db3-dccc4f3292e4"
            },
            "canBeSearched": false,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "89174d56-a663-45eb-a82b-e2ce397d1e77",
            "name": "Ramón",
            "surname": "Jupiter",
            "alias": "803902db6c904987a6361c3e91c6efa1",
            "email": "ramon.jupiter@bookker.es",
            "image": "https://develop.bookkercorp.com/admin/bookker/download/organizations/8aee218a-fce2-4900-9410-00f485a2729e/users/89174d56-a663-45eb-a82b-e2ce397d1e77/profile/fc9bd155dbc94c989fd212e55e504a58.jpeg",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "89174d56-a663-45eb-a82b-e2ce397d1e77"
            },
            "mobileRole": {
                "id": "1dfde059-da65-49c9-8db3-dccc4f3292e4"
            },
            "canBeSearched": true,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "bf5e2dbd-cce1-42a6-b309-14bf54e3470c",
            "name": "cesar@bookker.es",
            "surname": "-",
            "alias": "5bec3783-f380-4e68-b38a-510a44ec2da4",
            "email": "cesar@bookker.es",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "bf5e2dbd-cce1-42a6-b309-14bf54e3470c"
            },
            "mobileRole": {},
            "canBeSearched": false,
            "type": "BOOKKER_EXTERNAL"
        },
        {
            "id": "dc5916ba-daeb-4e6a-81e9-f8afe726668f",
            "name": "Jorge",
            "surname": "Jupiter",
            "alias": "86443f7bed984b6a95a0234796c07c49",
            "email": "jorge.jupiter@bookker.es",
            "image": "https://develop.bookkercorp.com/admin/bookker/download/organizations/8aee218a-fce2-4900-9410-00f485a2729e/users/dc5916ba-daeb-4e6a-81e9-f8afe726668f/profile/6bebb571be9a47c7b2ea5a691817c4e3.png",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "dc5916ba-daeb-4e6a-81e9-f8afe726668f"
            },
            "mobileRole": {
                "id": "1dfde059-da65-49c9-8db3-dccc4f3292e4"
            },
            "canBeSearched": true,
            "type": "BOOKKER_INTERNAL"
        },
        {
            "id": "e2917f49-1201-4c0b-93a5-38b7c74b777d",
            "name": "bartceslarr@gnail.com",
            "surname": "-",
            "alias": "bc85a421-ff10-4911-9815-cef987edce6b",
            "email": "bartceslarr@gnail.com",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "e2917f49-1201-4c0b-93a5-38b7c74b777d"
            },
            "mobileRole": {},
            "canBeSearched": false,
            "type": "BOOKKER_EXTERNAL"
        },
        {
            "id": "fb3f865e-154d-4e84-9515-1727507dfdf2",
            "name": "externo1@wxt.com",
            "surname": "-",
            "alias": "e4a6d31e-c20d-403f-8d13-8cc4cd485ff8",
            "email": "externo1@wxt.com",
            "organization": {
                "id": "8aee218a-fce2-4900-9410-00f485a2729e"
            },
            "userRule": {
                "id": "fb3f865e-154d-4e84-9515-1727507dfdf2"
            },
            "mobileRole": {},
            "canBeSearched": false,
            "type": "BOOKKER_EXTERNAL"
        }
    ]
}

Añadir contacto a favoritos

Añade un contacto a la lista de favoritos del usuario.

Request

HTTP request

POST /api/v1/users/me/contacts/{contactId}
POST /api/v1/users/{userId}/contacts/{contactId}

Headers

Header	Value	Required
Authorization	Bearer eyJ0eXBlIjoiSldUIiwiYWxnIjoiSFM1MT…	true

Response

Si se ha conseguido añadir el contacto a la lista de favoritos del usuario, se devuelve un código 201.

HTTP/1.1 201 Created

Quitar contacto de favoritos

Quita un contacto a la lista de favoritos del usuario.

Request

HTTP request

DELETE /api/v1/users/me/contacts/{contactId}
DELETE /api/v1/users/{userId}/contacts/{contactId}

Headers

Header	Value	Required
Authorization	Bearer eyJ0eXBlIjoiSldUIiwiYWxnIjoiSFM1MT…	true

Response

Si se ha conseguido quitar el contacto a la lista de favoritos del usuario, se devuelve un código 204.

HTTP/1.1 204 No Content