get
Returns the vCards that match the specified criteria.
Learn more
Restrictions
The method returns a maximum of page-size
objects.
Request
Request structure in JSON format:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* IdsCriteria */
"Ids": [(long), ... ] /* required */
},
"FieldNames": [( "Id" | "Country" | "City" | "Street" | "House" | "Building" | "Apartment" | "CompanyName" | "ExtraMessage" | "ContactPerson" | "ContactEmail" | "MetroStationId" | "CampaignId" | "Ogrn" | "WorkTime" | "InstantMessenger" | "Phone" | "PointOnMap" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Parameter |
Type |
Description |
Required |
params structure (for JSON) / GetRequest (for SOAP) |
|||
|
IdsCriteria |
vCard selection criteria. If omitted, all the advertiser's vCards are returned. |
No |
|
array of VCardFieldEnum |
The names of parameters to get. |
Yes |
|
Structure that defines the page for paginated selection of data. |
No |
|
IdsCriteria structure |
|||
|
array of long |
IDs of vCards to get. A maximum of |
Yes |
Response
Response structure in JSON format:
{
"result": {
"VCards": [{ /* VCardGetItem */
"Id": (long),
"CampaignId": (long),
"Country": (string),
"City": (string),
"WorkTime": (string),
"Phone": { /* Phone */
"CountryCode": (string), /* required */
"CityCode": (string), /* required */
"PhoneNumber": (string), /* required */
"Extension": (string)
},
"Street": (string), /* nillable */
"House": (string), /* nillable */
"Building": (string), /* nillable */
"Apartment": (string), /* nillable */
"InstantMessenger": { /* InstantMessenger */
"MessengerClient": (string), /* required */
"MessengerLogin": (string) /* required */
}, /* nillable */
"CompanyName": (string), /* nillable */
"ExtraMessage": (string), /* nillable */
"ContactEmail": (string), /* nillable */
"Ogrn": (string), /* nillable */
"MetroStationId": (long), /* nillable */
"PointOnMap": { /* MapPoint */
"X": (decimal), /* required */
"Y": (decimal), /* required */
"X1": (decimal), /* required */
"Y1": (decimal), /* required */
"X2": (decimal), /* required */
"Y2": (decimal) /* required */
}, /* nillable */
"ContactPerson": (string) /* nillable */
}, ... ],
"LimitedBy": (long)
}
}
Parameter |
Type |
Description |
result structure (for JSON) / GetResponse (for SOAP) |
||
|
array of VCardGetItem |
vCards. |
|
long |
Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection. |
VCardGetItem structure |
||
|
long |
vCard ID. |
|
long |
The campaign ID. |
|
string |
Country. Maximum of 50 characters. |
|
string |
The city. Maximum of 55 characters. |
|
string |
The operating hours or client service hours of the business. Set as a string that specifies the range of days of the week, work hours, and minutes. Days of the week are defined by the numbers from 0 to 6, where 0 is Monday and 6 is Sunday. Minutes are set as a multiple of 15: 0, 15, 30 or 45. String format: For example, the string
The schedule may consist of several strings in this format. For example: "
A 24-hour schedule is set using the string Maximum of 255 characters. |
|
Phone |
Structure that sets the phone number. |
|
string, nillable |
Street. Maximum of 55 characters. |
|
string, nillable |
House number. Maximum of 30 characters. |
|
string, nillable |
The building or unit number. Maximum of 10 characters. |
|
string, nillable |
The apartment or office number. Maximum of 100 characters. |
|
InstantMessenger, nillable |
A structure that sets the contact for instant messaging. |
|
string, nillable |
Name of the organization. Maximum of 255 characters. |
|
string, nillable |
Additional information on the advertised product or service. Maximum of 200 characters. |
|
string, nillable |
Email address. Maximum of 255 characters. |
|
string, nillable |
The OGRN code for a business registered in Russia. Maximum of 255 characters. |
|
long, nillable |
ID of the metro station. To get the list of stations, use the Dictionaries.get method. |
|
MapPoint, nillable |
Structure that describes the location of the placemark on the map. If not set, the map is marked at the address that was specified for the client. |
|
string, nillable |
Contact person. Maximum of 155 characters. |
Phone structure |
||
|
string |
The country code for the phone number. Must contain from 1 to 5 characters. Acceptable values:
For example, "+7" for Russia. |
|
string |
The area code or city code for the phone number. From 1 to 5 digits. Must not be 0. |
|
string |
The contact phone number. From 5 to 9 digits. When combined with the country code and city code, it is from 8 to 17 digits. |
|
string |
The phone extension, if an office PBX system is used. From 1 to 6 digits. |
InstantMessenger structure |
||
|
string |
The type of instant messaging system — icq, jabber, skype or mail_agent. |
|
string |
The username (ID) in the instant messaging system. Maximum of 255 characters. |
MapPoint structure |
||
|
decimal |
Longitude of the point. From -180 to 180. |
|
decimal |
Latitude of the point. From -90 to 90. |
|
decimal |
Longitude of the lower-left corner of the region on the map. From -180 to 180. |
|
decimal |
Latitude of the lower-left corner of the region on the map. From -90 to 90. |
|
decimal |
Longitude of the upper-right corner of the region on the map. From -180 to 180. |
|
decimal |
Latitude of the upper-right corner of the region on the map. From -90 to 90. |
Examples
Request example
{
"method": "get",
"params": {
"SelectionCriteria" : {
"Ids" : [ 13070327]
},
"FieldNames" : [
"Country",
"City",
"Phone"
]
}
}
Response example
{
"result" : {
"VCards" : [
{
"Phone" : {
"CityCode" : "812",
"Extension" : "89",
"PhoneNumber" : "123-45-67",
"CountryCode" : "+7"
},
"Country" : "Russia",
"City" : "Moscow"
}
]
}
}