/
4.1.18 Search

4.1.18 Search

URL: /search.ashx 

The method allows you to search for a specific user of vippie by: Vippie ID, name, surname, name and surname or email address. You must pass the search string to the "q" parameter, which must be larger than 3 characters. The search is performed using a full-text search mechanism. The method, unlike the previous version, does not have record paging. However, there is a limit to 100 records for one query. The result is sorted by relevance.

Parameter

Description

q

Query - Query to search.


curl --location --request POST 'https://xxxxxxxxx/emcd/search.ashx?q=piotr' \
--header 'User-Agent: vippie;ios;1.2.3' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic YW5kOmFuZDJhMzJkaW0=' 


In response, we will receive a list of found records in JSON format, where:

  • l - login - login of the SIP account
  • fn - first name 
  • ln - last name
  • em - email address
  • un - user name - Vippie ID
  • os - operating system - possible values: ios, and
  • pn - phone number - telephone number Note: the value may be empty if a given user has not allowed their telephone number to be shared, see profile -> personal data - sp parameter.
  • co - country 
  • ci - city 
  • ts - timespan - date of saving the avatar in the UTC+0:00 zone and the YYYY-MM-DDTHH:MM:SS format
  • fe - file exists - 1 - avatar file exists, 0 - avatar file is missing


Sample JSON object
[
       {
            "l":  user login,
            "fn": "user first name",
            "ln": "user last name",
            "em": "user@email.com",
            "pn": "1221342345345",
            "un": "user name",
            "os": "ios",
            "co": "Poland",
            "ci": "Warszawa",
            "fe": "0",
            "ts": "1900-01-01T00:00:00"
        },
        {
            "l":  1000043,
            "fn": "Sebastian",
            "ln": "Chojnacki",
            "em": "sebastian@vippie.com",
            "pn": "1002340001213"
            "un": "sebastian",
            "os": "bb",
            "co": "Poland",
            "ci": "Pozna?",
            "fe": "1",
            "ts": "2012-01-30T20:53:00"
        },
        ...
]

The old Search method

The method allows you to search for a specific vippie user by Vippie ID.

Parameter

Description

q

Query - query to find - Vippie ID.

pn

Page number - Number of the displayed page.

ps

Page size - The number of records displayed on a given page.

In response, we will receive a list of found records in JSON format, where:

  • rc - record count - number of all records (without paging)
  • rs - record set
  • l - login -login of sip account
  • fn - first name 
  • ln - last name 
  • em - email address
  • un - user name - Vippie ID
  • os - operating system - possible values : ios, and
  • pn - phone number - number Note: the value may be empty if a given user has not allowed their telephone number to be shared, see profile  -> personal data -sp parameter.
  • ts - timespan - date of saving the avatar in the UTC+0:00 zone and the YYYY-MM-DDTHH:MM:SS format
  • fs - file exists - 1 - avatar file exists, 0 - avatar file is missing
Sample JSON format
{
    "rc": 3,
    "rs": [
        {
            "l":  user login,
            "fn": "user first name",
            "ln": "user last name",
            "em": "user@email.com",
            "pn": "1221342345345",
            "un": "user name",
            "os": "ios",
            "fe": "0",
            "ts": "1900-01-01T00:00:00"
        },
        {
            "l":  1000043,
            "fn": "Sebastian",
            "ln": "Chojnacki",
            "em": "sebastian@vippie.com",
            "pn": "1002340001213"
            "un": "sebastian",
            "os": "bb"
            "fe": "1",
            "ts": "2012-01-30T20:53:00"
        },
        ...
    ]
}

Related content