| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
|---|
| 2 |
<wsdl:definitions name="IntegrationAPI2" targetNamespace="http://integration.yellowpages.com" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://integration.yellowpages.com" xmlns:tns2="http://data2.integration.yellowpages.com" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> |
|---|
| 3 |
|
|---|
| 4 |
|
|---|
| 5 |
<wsdl:documentation> |
|---|
| 6 |
|
|---|
| 7 |
The YellowPages.com Integration API is a set of web service that provide local business search |
|---|
| 8 |
services. |
|---|
| 9 |
A partner's application uses the Integration API to get business listings data in XML format |
|---|
| 10 |
using a standard protocol (SOAP over HTTP). |
|---|
| 11 |
The partner application can then re-organize the data acquired and present it on the Web using |
|---|
| 12 |
their own look and feel. |
|---|
| 13 |
|
|---|
| 14 |
To develop their client application, a partner will obtain the WSDL |
|---|
| 15 |
(Web Service Definition Language) file from the YPC web service. |
|---|
| 16 |
The WSDL lists all the data types and operations supported by the web service. |
|---|
| 17 |
The partner can then use a client development tool such as Apache Axis or Visual Studio |
|---|
| 18 |
to generate the network communication and XML parsing code of their application -- |
|---|
| 19 |
known as client stubs. |
|---|
| 20 |
That allows the partner to focus their development effort on business logic, not on plumbing. |
|---|
| 21 |
|
|---|
| 22 |
The API adds new services and evolves its behavior over time. |
|---|
| 23 |
When incompatible changes are needed, the old services are left as-is, |
|---|
| 24 |
and a new set of services are provided over a separate SOAP interface and a new WSDL file. |
|---|
| 25 |
|
|---|
| 26 |
This WSDL defines IntegrationAPI2, which is version 2.3 of the YellowPages.com API. |
|---|
| 27 |
Last Modified: 06 September 2007 |
|---|
| 28 |
</wsdl:documentation> |
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 |
<!-- Schema defining data types used in operations --> |
|---|
| 32 |
|
|---|
| 33 |
<wsdl:types> |
|---|
| 34 |
|
|---|
| 35 |
<xsd:schema targetNamespace="http://data2.integration.yellowpages.com" xmlns="http://www.w3.org/2001/XMLSchema"> |
|---|
| 36 |
|
|---|
| 37 |
<xsd:import namespace="http://schemas.xmlsoap.org/soap/encoding/"/> |
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 |
<xsd:complexType name="SearchResult"> |
|---|
| 41 |
|
|---|
| 42 |
<xsd:annotation> |
|---|
| 43 |
|
|---|
| 44 |
<xsd:documentation> |
|---|
| 45 |
|
|---|
| 46 |
Most operations return search results in a SearchResult object. |
|---|
| 47 |
The object can contain listings of a result set, |
|---|
| 48 |
the headings (categories) of the listings, |
|---|
| 49 |
and result metadata (properties). |
|---|
| 50 |
The exact items included in the SearchResult depend on the profileId parameter |
|---|
| 51 |
of the operation call. |
|---|
| 52 |
</xsd:documentation> |
|---|
| 53 |
|
|---|
| 54 |
</xsd:annotation> |
|---|
| 55 |
|
|---|
| 56 |
<xsd:sequence> |
|---|
| 57 |
|
|---|
| 58 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 59 |
|
|---|
| 60 |
<xsd:annotation> |
|---|
| 61 |
|
|---|
| 62 |
<xsd:documentation> |
|---|
| 63 |
|
|---|
| 64 |
A record (array of Property objects) containing the metadata for the result, |
|---|
| 65 |
such as number of items, actual location, etc. |
|---|
| 66 |
</xsd:documentation> |
|---|
| 67 |
|
|---|
| 68 |
</xsd:annotation> |
|---|
| 69 |
|
|---|
| 70 |
</xsd:element> |
|---|
| 71 |
|
|---|
| 72 |
<xsd:element name="Categories" nillable="true" type="tns2:ArrayOf_Categories"> |
|---|
| 73 |
|
|---|
| 74 |
<xsd:annotation> |
|---|
| 75 |
|
|---|
| 76 |
<xsd:documentation> |
|---|
| 77 |
|
|---|
| 78 |
Array of Category objects containing the categories of the found businesses. |
|---|
| 79 |
</xsd:documentation> |
|---|
| 80 |
|
|---|
| 81 |
</xsd:annotation> |
|---|
| 82 |
|
|---|
| 83 |
</xsd:element> |
|---|
| 84 |
|
|---|
| 85 |
<xsd:element name="Listings" nillable="true" type="tns2:ArrayOf_Listings"> |
|---|
| 86 |
|
|---|
| 87 |
<xsd:annotation> |
|---|
| 88 |
|
|---|
| 89 |
<xsd:documentation> |
|---|
| 90 |
|
|---|
| 91 |
Array of Listing objects containing the businesses found in a search. |
|---|
| 92 |
</xsd:documentation> |
|---|
| 93 |
|
|---|
| 94 |
</xsd:annotation> |
|---|
| 95 |
|
|---|
| 96 |
</xsd:element> |
|---|
| 97 |
|
|---|
| 98 |
</xsd:sequence> |
|---|
| 99 |
|
|---|
| 100 |
</xsd:complexType> |
|---|
| 101 |
|
|---|
| 102 |
|
|---|
| 103 |
<xsd:complexType name="Category"> |
|---|
| 104 |
|
|---|
| 105 |
<xsd:annotation> |
|---|
| 106 |
|
|---|
| 107 |
<xsd:documentation> |
|---|
| 108 |
|
|---|
| 109 |
A Category represents a classification of businesses. |
|---|
| 110 |
It consists of a single Record that contains all the attributes of the category, |
|---|
| 111 |
such as its name, ID, etc. |
|---|
| 112 |
</xsd:documentation> |
|---|
| 113 |
|
|---|
| 114 |
</xsd:annotation> |
|---|
| 115 |
|
|---|
| 116 |
<xsd:sequence> |
|---|
| 117 |
|
|---|
| 118 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 119 |
|
|---|
| 120 |
<xsd:annotation> |
|---|
| 121 |
|
|---|
| 122 |
<xsd:documentation> |
|---|
| 123 |
|
|---|
| 124 |
The properties (attributes) of the Category. |
|---|
| 125 |
</xsd:documentation> |
|---|
| 126 |
|
|---|
| 127 |
</xsd:annotation> |
|---|
| 128 |
|
|---|
| 129 |
</xsd:element> |
|---|
| 130 |
|
|---|
| 131 |
</xsd:sequence> |
|---|
| 132 |
|
|---|
| 133 |
</xsd:complexType> |
|---|
| 134 |
|
|---|
| 135 |
|
|---|
| 136 |
<xsd:complexType name="Listing"> |
|---|
| 137 |
|
|---|
| 138 |
<xsd:annotation> |
|---|
| 139 |
|
|---|
| 140 |
<xsd:documentation> |
|---|
| 141 |
|
|---|
| 142 |
A Listing represents a single business. |
|---|
| 143 |
It consists of a single Record that contains all the data fields and attributes of the business, |
|---|
| 144 |
such as its name, ID, phone number, etc. |
|---|
| 145 |
</xsd:documentation> |
|---|
| 146 |
|
|---|
| 147 |
</xsd:annotation> |
|---|
| 148 |
|
|---|
| 149 |
<xsd:sequence> |
|---|
| 150 |
|
|---|
| 151 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 152 |
|
|---|
| 153 |
<xsd:annotation> |
|---|
| 154 |
|
|---|
| 155 |
<xsd:documentation> |
|---|
| 156 |
|
|---|
| 157 |
The properties (data fields) of the Listing. |
|---|
| 158 |
</xsd:documentation> |
|---|
| 159 |
|
|---|
| 160 |
</xsd:annotation> |
|---|
| 161 |
|
|---|
| 162 |
</xsd:element> |
|---|
| 163 |
|
|---|
| 164 |
</xsd:sequence> |
|---|
| 165 |
|
|---|
| 166 |
</xsd:complexType> |
|---|
| 167 |
|
|---|
| 168 |
|
|---|
| 169 |
<xsd:complexType name="Property"> |
|---|
| 170 |
|
|---|
| 171 |
<xsd:annotation> |
|---|
| 172 |
|
|---|
| 173 |
<xsd:documentation> |
|---|
| 174 |
|
|---|
| 175 |
A Property holds a single name-value pair inside a Record. |
|---|
| 176 |
Because SOAP does not have a built-in way to represent a Record, |
|---|
| 177 |
the IntegrationAPI2 uses an array of Property objects to represent a Record. |
|---|
| 178 |
|
|---|
| 179 |
Another complication of SOAP is that it is hard to represent |
|---|
| 180 |
type-unions in a cross-platform manner. |
|---|
| 181 |
The value of a single property could potentially be a string, |
|---|
| 182 |
a number, an array, or another Record. |
|---|
| 183 |
We found that XML anyType values do not work well in some |
|---|
| 184 |
frameworks, so Property has 4 ways of accessing the single value. |
|---|
| 185 |
|
|---|
| 186 |
Note that only one of the 4 value fields |
|---|
| 187 |
(value, values, record, records) |
|---|
| 188 |
contains the property value. |
|---|
| 189 |
The other 3 fields will be nil. |
|---|
| 190 |
</xsd:documentation> |
|---|
| 191 |
|
|---|
| 192 |
</xsd:annotation> |
|---|
| 193 |
|
|---|
| 194 |
|
|---|
| 195 |
<xsd:sequence> |
|---|
| 196 |
|
|---|
| 197 |
<xsd:element maxOccurs="1" minOccurs="0" name="Value" nillable="false" type="xsd:string"> |
|---|
| 198 |
|
|---|
| 199 |
<xsd:annotation> |
|---|
| 200 |
|
|---|
| 201 |
<xsd:documentation> |
|---|
| 202 |
|
|---|
| 203 |
The field containing the value of the Property when the value is a scalar. |
|---|
| 204 |
It is always passed as a string, even for numeric values. |
|---|
| 205 |
</xsd:documentation> |
|---|
| 206 |
|
|---|
| 207 |
</xsd:annotation> |
|---|
| 208 |
|
|---|
| 209 |
</xsd:element> |
|---|
| 210 |
|
|---|
| 211 |
<xsd:element maxOccurs="1" minOccurs="0" name="Values" nillable="false" type="tns2:ArrayOf_Values"> |
|---|
| 212 |
|
|---|
| 213 |
<xsd:annotation> |
|---|
| 214 |
|
|---|
| 215 |
<xsd:documentation> |
|---|
| 216 |
|
|---|
| 217 |
The field containing the value of the Property when the value is an array of scalars. |
|---|
| 218 |
The array elements are always passed as strings. |
|---|
| 219 |
</xsd:documentation> |
|---|
| 220 |
|
|---|
| 221 |
</xsd:annotation> |
|---|
| 222 |
|
|---|
| 223 |
</xsd:element> |
|---|
| 224 |
|
|---|
| 225 |
<xsd:element maxOccurs="1" minOccurs="0" name="Record" nillable="false" type="tns2:ArrayOf_Properties"> |
|---|
| 226 |
|
|---|
| 227 |
<xsd:annotation> |
|---|
| 228 |
|
|---|
| 229 |
<xsd:documentation> |
|---|
| 230 |
|
|---|
| 231 |
The field containing the value of the Property when the value is itself an object with multiple |
|---|
| 232 |
fields. |
|---|
| 233 |
</xsd:documentation> |
|---|
| 234 |
|
|---|
| 235 |
</xsd:annotation> |
|---|
| 236 |
|
|---|
| 237 |
</xsd:element> |
|---|
| 238 |
|
|---|
| 239 |
<xsd:element maxOccurs="1" minOccurs="0" name="Records" nillable="false" type="tns2:ArrayOf_Records"> |
|---|
| 240 |
|
|---|
| 241 |
<xsd:annotation> |
|---|
| 242 |
|
|---|
| 243 |
<xsd:documentation> |
|---|
| 244 |
|
|---|
| 245 |
The field containing the value of the Property when the value is an array of objects |
|---|
| 246 |
who each have multiple fields. |
|---|
| 247 |
</xsd:documentation> |
|---|
| 248 |
|
|---|
| 249 |
</xsd:annotation> |
|---|
| 250 |
|
|---|
| 251 |
</xsd:element> |
|---|
| 252 |
|
|---|
| 253 |
</xsd:sequence> |
|---|
| 254 |
|
|---|
| 255 |
|
|---|
| 256 |
<xsd:attribute name="Name" type="xsd:string"> |
|---|
| 257 |
|
|---|
| 258 |
<xsd:annotation> |
|---|
| 259 |
|
|---|
| 260 |
<xsd:documentation> |
|---|
| 261 |
|
|---|
| 262 |
The name (or key) of the pair. |
|---|
| 263 |
Must be a string. |
|---|
| 264 |
</xsd:documentation> |
|---|
| 265 |
|
|---|
| 266 |
</xsd:annotation> |
|---|
| 267 |
|
|---|
| 268 |
</xsd:attribute> |
|---|
| 269 |
|
|---|
| 270 |
</xsd:complexType> |
|---|
| 271 |
|
|---|
| 272 |
|
|---|
| 273 |
<xsd:complexType name="SearchException"> |
|---|
| 274 |
|
|---|
| 275 |
<xsd:annotation> |
|---|
| 276 |
|
|---|
| 277 |
<xsd:documentation> |
|---|
| 278 |
|
|---|
| 279 |
A SearchException includes metadata about the failed operation, |
|---|
| 280 |
including the parameters that were passed to the operation. |
|---|
| 281 |
Client programmers may be able to inspect the metadata to help diagnose errors. |
|---|
| 282 |
|
|---|
| 283 |
The operations will return SOAP faults of type SearchException in the following situations: |
|---|
| 284 |
* Invalid location (bad lat/lon, or can't find city/state or zip); |
|---|
| 285 |
* Invalid radius (negative or zero); |
|---|
| 286 |
* Invalid partner ID; |
|---|
| 287 |
* Invalid profile ID; |
|---|
| 288 |
* Invalid listing ID; |
|---|
| 289 |
* Invalid page number or size (negative or zero); |
|---|
| 290 |
* For "OfExactCategory" searches, when an invalid heading is passed. |
|---|
| 291 |
|
|---|
| 292 |
Other server-side errors will return standard SOAP faults. |
|---|
| 293 |
</xsd:documentation> |
|---|
| 294 |
|
|---|
| 295 |
</xsd:annotation> |
|---|
| 296 |
|
|---|
| 297 |
<xsd:sequence> |
|---|
| 298 |
|
|---|
| 299 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 300 |
|
|---|
| 301 |
<xsd:annotation> |
|---|
| 302 |
|
|---|
| 303 |
<xsd:documentation> |
|---|
| 304 |
|
|---|
| 305 |
A record (array of Property objects) containing the metadata for the error, |
|---|
| 306 |
such as an error message, copies of the parameters, etc. |
|---|
| 307 |
</xsd:documentation> |
|---|
| 308 |
|
|---|
| 309 |
</xsd:annotation> |
|---|
| 310 |
|
|---|
| 311 |
</xsd:element> |
|---|
| 312 |
|
|---|
| 313 |
</xsd:sequence> |
|---|
| 314 |
|
|---|
| 315 |
</xsd:complexType> |
|---|
| 316 |
|
|---|
| 317 |
|
|---|
| 318 |
<xsd:complexType name="Record"> |
|---|
| 319 |
|
|---|
| 320 |
<xsd:annotation> |
|---|
| 321 |
|
|---|
| 322 |
<xsd:documentation> |
|---|
| 323 |
|
|---|
| 324 |
Much of the data used and returned by the API is in the form of Record objects. |
|---|
| 325 |
A Record is a structure that can include any number of name-value pairs, |
|---|
| 326 |
much like a Java Map, Python dict, or Javascript Object. |
|---|
| 327 |
|
|---|
| 328 |
The SOAP Record type is used when multiple records appear in an array. |
|---|
| 329 |
</xsd:documentation> |
|---|
| 330 |
|
|---|
| 331 |
</xsd:annotation> |
|---|
| 332 |
|
|---|
| 333 |
<xsd:sequence> |
|---|
| 334 |
|
|---|
| 335 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 336 |
|
|---|
| 337 |
<xsd:annotation> |
|---|
| 338 |
|
|---|
| 339 |
<xsd:documentation> |
|---|
| 340 |
|
|---|
| 341 |
Individual element of the above array. The Property |
|---|
| 342 |
holding the final name value pairs. |
|---|
| 343 |
</xsd:documentation> |
|---|
| 344 |
|
|---|
| 345 |
</xsd:annotation> |
|---|
| 346 |
|
|---|
| 347 |
</xsd:element> |
|---|
| 348 |
|
|---|
| 349 |
</xsd:sequence> |
|---|
| 350 |
|
|---|
| 351 |
</xsd:complexType> |
|---|
| 352 |
|
|---|
| 353 |
|
|---|
| 354 |
<xsd:complexType name="ArrayOf_Properties"> |
|---|
| 355 |
|
|---|
| 356 |
<xsd:annotation> |
|---|
| 357 |
|
|---|
| 358 |
<xsd:documentation> |
|---|
| 359 |
|
|---|
| 360 |
Much of the data used and returned by the API is in the form of Record objects. |
|---|
| 361 |
A Record is a structure that can include any number of name-value pairs, |
|---|
| 362 |
much like a Java Map, Python dict, or Javascript Object. |
|---|
| 363 |
|
|---|
| 364 |
The SOAP Property[] is used when a single record is needed. |
|---|
| 365 |
</xsd:documentation> |
|---|
| 366 |
|
|---|
| 367 |
</xsd:annotation> |
|---|
| 368 |
|
|---|
| 369 |
<xsd:sequence> |
|---|
| 370 |
|
|---|
| 371 |
<xsd:element maxOccurs="unbounded" name="Property" nillable="true" type="tns2:Property"/> |
|---|
| 372 |
|
|---|
| 373 |
</xsd:sequence> |
|---|
| 374 |
|
|---|
| 375 |
</xsd:complexType> |
|---|
| 376 |
|
|---|
| 377 |
|
|---|
| 378 |
<xsd:complexType name="ArrayOf_Categories"> |
|---|
| 379 |
|
|---|
| 380 |
<xsd:sequence> |
|---|
| 381 |
|
|---|
| 382 |
<xsd:element maxOccurs="unbounded" name="Category" nillable="true" type="tns2:Category"/> |
|---|
| 383 |
|
|---|
| 384 |
</xsd:sequence> |
|---|
| 385 |
|
|---|
| 386 |
</xsd:complexType> |
|---|
| 387 |
|
|---|
| 388 |
|
|---|
| 389 |
<xsd:complexType name="ArrayOf_Listings"> |
|---|
| 390 |
|
|---|
| 391 |
<xsd:sequence> |
|---|
| 392 |
|
|---|
| 393 |
<xsd:element maxOccurs="unbounded" name="Listing" nillable="true" type="tns2:Listing"/> |
|---|
| 394 |
|
|---|
| 395 |
</xsd:sequence> |
|---|
| 396 |
|
|---|
| 397 |
</xsd:complexType> |
|---|
| 398 |
|
|---|
| 399 |
|
|---|
| 400 |
<xsd:complexType name="ArrayOf_Records"> |
|---|
| 401 |
|
|---|
| 402 |
<xsd:annotation> |
|---|
| 403 |
|
|---|
| 404 |
<xsd:documentation> |
|---|
| 405 |
|
|---|
| 406 |
Array of Records, each of which holds an array of Property. |
|---|
| 407 |
</xsd:documentation> |
|---|
| 408 |
|
|---|
| 409 |
</xsd:annotation> |
|---|
| 410 |
|
|---|
| 411 |
<xsd:sequence> |
|---|
| 412 |
|
|---|
| 413 |
<xsd:element maxOccurs="unbounded" name="Record" nillable="true" type="tns2:Record"/> |
|---|
| 414 |
|
|---|
| 415 |
</xsd:sequence> |
|---|
| 416 |
|
|---|
| 417 |
</xsd:complexType> |
|---|
| 418 |
|
|---|
| 419 |
|
|---|
| 420 |
|
|---|
| 421 |
<xsd:complexType name="ArrayOf_Values"> |
|---|
| 422 |
|
|---|
| 423 |
<xsd:annotation> |
|---|
| 424 |
|
|---|
| 425 |
<xsd:documentation> |
|---|
| 426 |
|
|---|
| 427 |
Array of Strings for properties that have |
|---|
| 428 |
one name but multiple string values. |
|---|
| 429 |
</xsd:documentation> |
|---|
| 430 |
|
|---|
| 431 |
</xsd:annotation> |
|---|
| 432 |
|
|---|
| 433 |
<xsd:sequence> |
|---|
| 434 |
|
|---|
| 435 |
<xsd:element maxOccurs="unbounded" name="Value" type="xsd:string"/> |
|---|
| 436 |
|
|---|
| 437 |
</xsd:sequence> |
|---|
| 438 |
|
|---|
| 439 |
</xsd:complexType> |
|---|
| 440 |
|
|---|
| 441 |
|
|---|
| 442 |
<!-- begin API2 map type part --> |
|---|
| 443 |
|
|---|
| 444 |
|
|---|
| 445 |
<!-- the get map result object --> |
|---|
| 446 |
|
|---|
| 447 |
<xsd:complexType name="MapResult"> |
|---|
| 448 |
|
|---|
| 449 |
<xsd:annotation> |
|---|
| 450 |
|
|---|
| 451 |
<xsd:documentation> |
|---|
| 452 |
|
|---|
| 453 |
The get map result, contins list of name value pair properties. |
|---|
| 454 |
</xsd:documentation> |
|---|
| 455 |
|
|---|
| 456 |
</xsd:annotation> |
|---|
| 457 |
|
|---|
| 458 |
<xsd:sequence> |
|---|
| 459 |
|
|---|
| 460 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 461 |
|
|---|
| 462 |
<xsd:annotation> |
|---|
| 463 |
|
|---|
| 464 |
<xsd:documentation> |
|---|
| 465 |
|
|---|
| 466 |
A record (array of Property objects) containing list of name value pair properties for |
|---|
| 467 |
map result. |
|---|
| 468 |
(1) the parameters' values that were passed for map operations; |
|---|
| 469 |
(2) the map URL link; |
|---|
| 470 |
(3) the list of properties for further zoom and pan, such as topLatitude, |
|---|
| 471 |
leftLongitude, bottomLatitude, rightLongitude etc. |
|---|
| 472 |
|
|---|
| 473 |
</xsd:documentation> |
|---|
| 474 |
|
|---|
| 475 |
</xsd:annotation> |
|---|
| 476 |
|
|---|
| 477 |
</xsd:element> |
|---|
| 478 |
|
|---|
| 479 |
</xsd:sequence> |
|---|
| 480 |
|
|---|
| 481 |
</xsd:complexType> |
|---|
| 482 |
|
|---|
| 483 |
|
|---|
| 484 |
<!-- the exception of get map --> |
|---|
| 485 |
|
|---|
| 486 |
<xsd:complexType name="MapException"> |
|---|
| 487 |
|
|---|
| 488 |
<xsd:annotation> |
|---|
| 489 |
|
|---|
| 490 |
<xsd:documentation> |
|---|
| 491 |
|
|---|
| 492 |
A MapException includes metadata about the failed operation, |
|---|
| 493 |
including the parameters that were passed to the operation. |
|---|
| 494 |
Client programmers may be able to inspect the metadata to help diagnose errors. |
|---|
| 495 |
|
|---|
| 496 |
The operations will return SOAP faults of type MapException in the following situations: |
|---|
| 497 |
* Invalid location (invalid city/state or zip); |
|---|
| 498 |
* Invalid radius (negative); |
|---|
| 499 |
* Invalid partner ID; |
|---|
| 500 |
* Invalid profile ID; |
|---|
| 501 |
</xsd:documentation> |
|---|
| 502 |
|
|---|
| 503 |
</xsd:annotation> |
|---|
| 504 |
|
|---|
| 505 |
<xsd:sequence> |
|---|
| 506 |
|
|---|
| 507 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 508 |
|
|---|
| 509 |
<xsd:annotation> |
|---|
| 510 |
|
|---|
| 511 |
<xsd:documentation> |
|---|
| 512 |
|
|---|
| 513 |
A record (array of Property objects) containing the metadata for the error, |
|---|
| 514 |
such as an error message, copies of the parameters, etc. |
|---|
| 515 |
</xsd:documentation> |
|---|
| 516 |
|
|---|
| 517 |
</xsd:annotation> |
|---|
| 518 |
|
|---|
| 519 |
</xsd:element> |
|---|
| 520 |
|
|---|
| 521 |
</xsd:sequence> |
|---|
| 522 |
|
|---|
| 523 |
</xsd:complexType> |
|---|
| 524 |
|
|---|
| 525 |
|
|---|
| 526 |
<xsd:complexType name="RouteResult"> |
|---|
| 527 |
|
|---|
| 528 |
<xsd:annotation> |
|---|
| 529 |
|
|---|
| 530 |
<xsd:documentation> |
|---|
| 531 |
|
|---|
| 532 |
Route operations return direction results in a RouteResult object. |
|---|
| 533 |
The object will contain result metadata (properties) |
|---|
| 534 |
and driving directions. |
|---|
| 535 |
</xsd:documentation> |
|---|
| 536 |
|
|---|
| 537 |
</xsd:annotation> |
|---|
| 538 |
|
|---|
| 539 |
<xsd:sequence> |
|---|
| 540 |
|
|---|
| 541 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 542 |
|
|---|
| 543 |
<xsd:annotation> |
|---|
| 544 |
|
|---|
| 545 |
<xsd:documentation> |
|---|
| 546 |
|
|---|
| 547 |
A record (array of Property objects) containing the metadata for the result, |
|---|
| 548 |
such as number of items, actual location, etc. |
|---|
| 549 |
</xsd:documentation> |
|---|
| 550 |
|
|---|
| 551 |
</xsd:annotation> |
|---|
| 552 |
|
|---|
| 553 |
</xsd:element> |
|---|
| 554 |
|
|---|
| 555 |
<xsd:element name="Directions" nillable="true" type="tns2:ArrayOf_Records"> |
|---|
| 556 |
|
|---|
| 557 |
<xsd:annotation> |
|---|
| 558 |
|
|---|
| 559 |
<xsd:documentation> |
|---|
| 560 |
|
|---|
| 561 |
Array of directions objects containing the directions |
|---|
| 562 |
</xsd:documentation> |
|---|
| 563 |
|
|---|
| 564 |
</xsd:annotation> |
|---|
| 565 |
|
|---|
| 566 |
</xsd:element> |
|---|
| 567 |
|
|---|
| 568 |
</xsd:sequence> |
|---|
| 569 |
|
|---|
| 570 |
</xsd:complexType> |
|---|
| 571 |
|
|---|
| 572 |
|
|---|
| 573 |
<xsd:complexType name="GeoResult"> |
|---|
| 574 |
|
|---|
| 575 |
<xsd:annotation> |
|---|
| 576 |
|
|---|
| 577 |
<xsd:documentation> |
|---|
| 578 |
|
|---|
| 579 |
A GeoResult is much like a SearchResult that contains |
|---|
| 580 |
only geographic data instead of listings and categories. |
|---|
| 581 |
It consists of a single Record (collection of |
|---|
| 582 |
Properties) that contain the geographic data. |
|---|
| 583 |
</xsd:documentation> |
|---|
| 584 |
|
|---|
| 585 |
</xsd:annotation> |
|---|
| 586 |
|
|---|
| 587 |
<xsd:sequence> |
|---|
| 588 |
|
|---|
| 589 |
<xsd:element name="Properties" nillable="true" type="tns2:ArrayOf_Properties"> |
|---|
| 590 |
|
|---|
| 591 |
<xsd:annotation> |
|---|
| 592 |
|
|---|
| 593 |
<xsd:documentation> |
|---|
| 594 |
|
|---|
| 595 |
In "did you mean" scenarios when there is one or |
|---|
| 596 |
more possible locations that match the user's |
|---|
| 597 |
parameters, the locations are listed in this |
|---|
| 598 |
property. The property will not be present when |
|---|
| 599 |
there are no suggested locations. The "success" |
|---|
| 600 |
result is included among the alternatives. |
|---|
| 601 |
</xsd:documentation> |
|---|
| 602 |
|
|---|
| 603 |
</xsd:annotation> |
|---|
| 604 |
|
|---|
| 605 |
</xsd:element> |
|---|
| 606 |
|
|---|
| 607 |
</xsd:sequence> |
|---|
| 608 |
|
|---|
| 609 |
</xsd:complexType> |
|---|
| 610 |
|
|---|
| 611 |
<!-- end API2 map type part --> |
|---|
| 612 |
|
|---|
| 613 |
</xsd:schema> |
|---|
| 614 |
|
|---|
| 615 |
</wsdl:types> |
|---|
| 616 |
|
|---|
| 617 |
|
|---|
| 618 |
|
|---|
| 619 |
|
|---|
| 620 |
<!-- SOAP messages decribing parameter lists and results --> |
|---|
| 621 |
|
|---|
| 622 |
|
|---|
| 623 |
<wsdl:message name="SearchResponse"> |
|---|
| 624 |
|
|---|
| 625 |
<wsdl:part name="SearchResult" type="tns2:SearchResult"> |
|---|
| 626 |
|
|---|
| 627 |
</wsdl:part> |
|---|
| 628 |
|
|---|
| 629 |
</wsdl:message> |
|---|
| 630 |
|
|---|
| 631 |
|
|---|
| 632 |
<wsdl:message name="SearchExceptionResponse"> |
|---|
| 633 |
|
|---|
| 634 |
<wsdl:part name="SearchException" type="tns2:SearchException"> |
|---|
| 635 |
|
|---|
| 636 |
</wsdl:part> |
|---|
| 637 |
|
|---|
| 638 |
</wsdl:message> |
|---|
| 639 |
|
|---|
| 640 |
|
|---|
| 641 |
<!-- Parameters for search by lat/lon --> |
|---|
| 642 |
|
|---|
| 643 |
|
|---|
| 644 |
<wsdl:message name="distanceSearchOnLatLonRequest"> |
|---|
| 645 |
|
|---|
| 646 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 647 |
|
|---|
| 648 |
<wsdl:part name="latitude" type="xsd:double"/> |
|---|
| 649 |
|
|---|
| 650 |
<wsdl:part name="longitude" type="xsd:double"/> |
|---|
| 651 |
|
|---|
| 652 |
<wsdl:part name="radius" type="xsd:double"/> |
|---|
| 653 |
|
|---|
| 654 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 655 |
|
|---|
| 656 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 657 |
|
|---|
| 658 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 659 |
|
|---|
| 660 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 661 |
|
|---|
| 662 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 663 |
|
|---|
| 664 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 665 |
|
|---|
| 666 |
</wsdl:message> |
|---|
| 667 |
|
|---|
| 668 |
|
|---|
| 669 |
<wsdl:message name="directorySearchOnLatLonRequest"> |
|---|
| 670 |
|
|---|
| 671 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 672 |
|
|---|
| 673 |
<wsdl:part name="latitude" type="xsd:double"/> |
|---|
| 674 |
|
|---|
| 675 |
<wsdl:part name="longitude" type="xsd:double"/> |
|---|
| 676 |
|
|---|
| 677 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 678 |
|
|---|
| 679 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 680 |
|
|---|
| 681 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 682 |
|
|---|
| 683 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 684 |
|
|---|
| 685 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 686 |
|
|---|
| 687 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 688 |
|
|---|
| 689 |
</wsdl:message> |
|---|
| 690 |
|
|---|
| 691 |
|
|---|
| 692 |
<wsdl:message name="tileSearchOnLatLonRequest"> |
|---|
| 693 |
|
|---|
| 694 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 695 |
|
|---|
| 696 |
<wsdl:part name="latitude" type="xsd:double"/> |
|---|
| 697 |
|
|---|
| 698 |
<wsdl:part name="longitude" type="xsd:double"/> |
|---|
| 699 |
|
|---|
| 700 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 701 |
|
|---|
| 702 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 703 |
|
|---|
| 704 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 705 |
|
|---|
| 706 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 707 |
|
|---|
| 708 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 709 |
|
|---|
| 710 |
</wsdl:message> |
|---|
| 711 |
|
|---|
| 712 |
|
|---|
| 713 |
<!-- Parameters for search by city/state --> |
|---|
| 714 |
|
|---|
| 715 |
|
|---|
| 716 |
<wsdl:message name="distanceSearchOnCityStateRequest"> |
|---|
| 717 |
|
|---|
| 718 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 719 |
|
|---|
| 720 |
<wsdl:part name="city" type="xsd:string"/> |
|---|
| 721 |
|
|---|
| 722 |
<wsdl:part name="state" type="xsd:string"/> |
|---|
| 723 |
|
|---|
| 724 |
<wsdl:part name="radius" type="xsd:double"/> |
|---|
| 725 |
|
|---|
| 726 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 727 |
|
|---|
| 728 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 729 |
|
|---|
| 730 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 731 |
|
|---|
| 732 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 733 |
|
|---|
| 734 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 735 |
|
|---|
| 736 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 737 |
|
|---|
| 738 |
</wsdl:message> |
|---|
| 739 |
|
|---|
| 740 |
|
|---|
| 741 |
<wsdl:message name="directorySearchOnCityStateRequest"> |
|---|
| 742 |
|
|---|
| 743 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 744 |
|
|---|
| 745 |
<wsdl:part name="city" type="xsd:string"/> |
|---|
| 746 |
|
|---|
| 747 |
<wsdl:part name="state" type="xsd:string"/> |
|---|
| 748 |
|
|---|
| 749 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 750 |
|
|---|
| 751 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 752 |
|
|---|
| 753 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 754 |
|
|---|
| 755 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 756 |
|
|---|
| 757 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 758 |
|
|---|
| 759 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 760 |
|
|---|
| 761 |
</wsdl:message> |
|---|
| 762 |
|
|---|
| 763 |
|
|---|
| 764 |
<wsdl:message name="tileSearchOnCityStateRequest"> |
|---|
| 765 |
|
|---|
| 766 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 767 |
|
|---|
| 768 |
<wsdl:part name="city" type="xsd:string"/> |
|---|
| 769 |
|
|---|
| 770 |
<wsdl:part name="state" type="xsd:string"/> |
|---|
| 771 |
|
|---|
| 772 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 773 |
|
|---|
| 774 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 775 |
|
|---|
| 776 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 777 |
|
|---|
| 778 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 779 |
|
|---|
| 780 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 781 |
|
|---|
| 782 |
</wsdl:message> |
|---|
| 783 |
|
|---|
| 784 |
|
|---|
| 785 |
<!-- Parameters for search by zip --> |
|---|
| 786 |
|
|---|
| 787 |
|
|---|
| 788 |
<wsdl:message name="distanceSearchOnZipRequest"> |
|---|
| 789 |
|
|---|
| 790 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 791 |
|
|---|
| 792 |
<wsdl:part name="zip" type="xsd:string"/> |
|---|
| 793 |
|
|---|
| 794 |
<wsdl:part name="radius" type="xsd:double"/> |
|---|
| 795 |
|
|---|
| 796 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 797 |
|
|---|
| 798 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 799 |
|
|---|
| 800 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 801 |
|
|---|
| 802 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 803 |
|
|---|
| 804 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 805 |
|
|---|
| 806 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 807 |
|
|---|
| 808 |
</wsdl:message> |
|---|
| 809 |
|
|---|
| 810 |
|
|---|
| 811 |
<wsdl:message name="directorySearchOnZipRequest"> |
|---|
| 812 |
|
|---|
| 813 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 814 |
|
|---|
| 815 |
<wsdl:part name="zip" type="xsd:string"/> |
|---|
| 816 |
|
|---|
| 817 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 818 |
|
|---|
| 819 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 820 |
|
|---|
| 821 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 822 |
|
|---|
| 823 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 824 |
|
|---|
| 825 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 826 |
|
|---|
| 827 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 828 |
|
|---|
| 829 |
</wsdl:message> |
|---|
| 830 |
|
|---|
| 831 |
|
|---|
| 832 |
<wsdl:message name="tileSearchOnZipRequest"> |
|---|
| 833 |
|
|---|
| 834 |
<wsdl:part name="term" type="xsd:string"/> |
|---|
| 835 |
|
|---|
| 836 |
<wsdl:part name="zip" type="xsd:string"/> |
|---|
| 837 |
|
|---|
| 838 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 839 |
|
|---|
| 840 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 841 |
|
|---|
| 842 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 843 |
|
|---|
| 844 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 845 |
|
|---|
| 846 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 847 |
|
|---|
| 848 |
</wsdl:message> |
|---|
| 849 |
|
|---|
| 850 |
|
|---|
| 851 |
<!-- Parameters for search by listing ID --> |
|---|
| 852 |
|
|---|
| 853 |
|
|---|
| 854 |
<wsdl:message name="getListingRequest"> |
|---|
| 855 |
|
|---|
| 856 |
<wsdl:part name="listingId" type="xsd:string"/> |
|---|
| 857 |
|
|---|
| 858 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 859 |
|
|---|
| 860 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 861 |
|
|---|
| 862 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 863 |
|
|---|
| 864 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 865 |
|
|---|
| 866 |
</wsdl:message> |
|---|
| 867 |
|
|---|
| 868 |
|
|---|
| 869 |
<wsdl:message name="distanceSearchOfCategoriesAtLatLonRequest"> |
|---|
| 870 |
|
|---|
| 871 |
<wsdl:part name="categories" type="tns2:ArrayOf_Values"/> |
|---|
| 872 |
|
|---|
| 873 |
<wsdl:part name="latitude" type="xsd:double"/> |
|---|
| 874 |
|
|---|
| 875 |
<wsdl:part name="longitude" type="xsd:double"/> |
|---|
| 876 |
|
|---|
| 877 |
<wsdl:part name="radius" type="xsd:double"/> |
|---|
| 878 |
|
|---|
| 879 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 880 |
|
|---|
| 881 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 882 |
|
|---|
| 883 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 884 |
|
|---|
| 885 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 886 |
|
|---|
| 887 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 888 |
|
|---|
| 889 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 890 |
|
|---|
| 891 |
</wsdl:message> |
|---|
| 892 |
|
|---|
| 893 |
|
|---|
| 894 |
<wsdl:message name="distanceSearchOfCategoriesAtCityStateRequest"> |
|---|
| 895 |
|
|---|
| 896 |
<wsdl:part name="categories" type="tns2:ArrayOf_Values"/> |
|---|
| 897 |
|
|---|
| 898 |
<wsdl:part name="city" type="xsd:string"/> |
|---|
| 899 |
|
|---|
| 900 |
<wsdl:part name="state" type="xsd:string"/> |
|---|
| 901 |
|
|---|
| 902 |
<wsdl:part name="radius" type="xsd:double"/> |
|---|
| 903 |
|
|---|
| 904 |
<wsdl:part name="profileId" type="xsd:string"/> |
|---|
| 905 |
|
|---|
| 906 |
<wsdl:part name="pageNumber" type="xsd:int"/> |
|---|
| 907 |
|
|---|
| 908 |
<wsdl:part name="pageSize" type="xsd:int"/> |
|---|
| 909 |
|
|---|
| 910 |
<wsdl:part name="partnerId" type="xsd:string"/> |
|---|
| 911 |
|
|---|
| 912 |
<wsdl:part name="userId" type="xsd:string"/> |
|---|
| 913 |
|
|---|
| 914 |
<wsdl:part name="transactionId" type="xsd:string"/> |
|---|
| 915 |
|
|---|
| 916 |
  |
|---|