Data model
This page describes the XML output generated by a response from a call to PWS. It is assumed that you are familiar with the basics of XML and understand the terminology of child/parent elements.
The PhoneDogResponse root element and its children
| PhoneDogResponse/ |
|
|
| |
Request/ |
Header that returns the input parameter name and values that were used to generate the response to this request. |
| |
Errors/ |
Returns possible error messages if the request was malformed and/or unsuccessful |
| |
CellularItems/ |
If you're using either the CellularItemLookup, CellularItemSearch CellularItemAvailability operation, this element will contain all the CellularItem elements. |
| |
CellularItemExpertReviews |
If you're using the CelularItemExpertReviewsLookup operation, this element will contain all the CellularItemExpertReview elements. |
| |
CellularPlans/ |
If you're using either the CellularPlanLookup or CellularPlanSearch operation, this element will contain all the CellularPlan elements. |
CellularItems element
| CellularItem/ |
|
|
| |
ModelName |
Model name of the cell phone excluding the manufacturer name |
| |
ModelBaseName |
The base model name (the same as the model name but excluding possible color or other variation) |
| |
DisplayName |
The name of the manufacturer and model name together |
| |
UrlDetails |
Url for full details of this item on phonedog.com |
| |
UrlManual |
Url to download the user manual in PDF format (if available) |
| |
HasExpertReviews |
This element will be available with the value "Yes" if there are in-depth expert reviews available for this phone. If this element is available you may use the CellularItemExpertReviewsLookup operation to retreive related expert reviews |
| |
Technology |
The primary technology supported by this phone (e.g. CDMA, GSM, etc.) |
| |
Frequencies/ |
Frequencies element that contains all the bands this phone supports (e.g. 800, 850, 1800, 1900, 2100, etc.) |
| |
UserRating |
User rating as a value from 0 to 5, 0=not rated, 1=worst, 5=best |
| |
Manufacturer/ |
Manufacturer element that includes the Name child element |
| |
Description |
Short product marketing description |
| |
ImageThumb |
URL and dimensions (in pixels) of a thumb image of the item |
| |
ImageSmall |
URL and dimensions (in pixels) of a small image of the item |
| |
ImageMedium |
URL and dimensions (in pixels) of a medium image of the item |
| |
ImageLarge |
URL and dimensions (in pixels) of a large image of the item |
| |
ImageGallery/ |
Contains image elements of all available images for this item |
| |
BuyingChoices/ |
Provides buying choices from many different vendors and merchants that currently offer this cell phone for sale either with new service, pre-paid service or as a stand-alone phone-only. BuyingChoices allows you to offer your visitors comparative shopping information with the lowest and most up-to-date pricing available. |
| |
Specifications/ |
Contains grouped attribute elements that describe the items characteristics and features. |
| |
UserReviews/ |
Contains user opinions and reviews for the current item. |
BuyingChoices element
| BuyingChoice |
|
Note: Each buying choice element contains a "type" attribute that differentiates how this item is being sold (e.g "phoneandplan", "phoneonly", "prepaid"). Use this attribute to seperate these service types into seperate categories on your layout. |
| |
Merchant/ |
Contains the name of the merchant offering this phone as well as their current user rating (0=not rated, 1=worst, 5=best). May also contain three logo images (small, medium, large) depending on what response groups are requested. |
| |
Provider/ |
For "phoneandplan" and "prepaid" buying choice types, this element contains the name of the provider (carrier) that this phone would be activated with, as well as the current user rating and possible logo images. |
| |
BasePrice |
The base price of the item |
| |
MsrpPrice |
The suggested retail price of the item |
| |
RebatePrice |
Rebate price (if available) |
| |
FinalPrice |
The final price (after all rebates) |
| |
RebateDescription |
A possible rebate description |
| |
UrlPurchase |
URL to purchase this item from the current merchant |
| |
UrlPurchaseWithFamilyPlan |
For "phoneandplan" buying choices, this url will allow the user to purchase this item with a family (shared) plan. |
Specifications element
| Group |
|
Specifications are grouped into categories (e.g. Data & Messaging, General Features, etc.) |
| |
Attribute |
Contains the name and value of the attribute. |
UserReviews element
| UserReview |
|
|
| |
Date |
The date the review was submitted by the user |
| |
TotalVotes |
Visitors have the option to vote a review as either being helpful or not helpful. This is the total number of votes that this review has received so far. |
| |
HelpfulVotes |
Total number of users that voted this review to be helpful to them after reading it. |
| |
Rating |
1=worst, 5=best |
| |
Experience |
The amount of experience (ownership length) that the reviewer has had with this item before submitting his/her review. e.g. 1 day to 10+ years |
| |
Title |
The title of the review |
| |
Content/Pros |
Although not required, all users have the option to enter positive and negative information about this item. |
| |
Content/Cons |
Although not required, all users have the option to enter positive and negative information about this item. |
| |
Content/Summary |
All users must complete a summary of their review. |
CellularExpertReviews element
| CellularExpertReview |
|
|
| |
PublishDate |
The date the review was originally published on phonedog.com |
| |
Author/ |
Author element containing information about the author of the review (e.g. name) |
| |
ModelName |
The model name (excluding the manufacturer) of the phone |
| |
DisplayName |
Full display name of the phone including the manufacturer |
| |
ImageThumb |
URL and dimensions (in pixels) of a thumb image of the item |
| |
ImageSmall |
URL and dimensions (in pixels) of a small image of the item |
| |
ImageMedium |
URL and dimensions (in pixels) of a medium image of the item |
| |
ImageLarge |
URL and dimensions (in pixels) of a large image of the item |
| |
Ratings/ |
Ratings element containing attribute elements with the name and rating of each individual feature |
| |
Chapter/ |
Collection of chapter elements containing the name and content of each chapter |
CellularPlans element
| CellularPlan/ |
|
|
| |
Name |
Name of the wireless rate plan |
| |
UrlDetails |
Url for full details of this plan on phonedog.com |
| |
Provider/ |
Provider element that includes the Name and Image (logos) child elements |
| |
PlanType |
Possible values are: Individual or Family |
| |
CoverageArea |
Possible values are: Regional or National |
| |
ContractTerm |
Required contract length (e.g. 2 years, 1-2 years, 18 months, mont-to-month, etc.) |
| |
Rate |
Depending on whether this is a prepaid or postpaid rate plan this value indicates the recurring monthly or upfront cost. |
| |
MinutesIncluded |
Number of minutes included with this rate plan |
| |
AdditionalMinutes |
Cost per additional minute when using more than the included minutes that are part of each billing cycle |
| |
MinutesMobileToMobile |
Number of minutes available for calling mobile-to-mobile (if applicable) |
| |
MinutesWalkieTalkie |
Number of walkie-talkie minutes included (if applicable) |
| |
MinutesNightWeekend |
Number of minutes included for calling on nights & weekends |
| |
NightWeekendPeriod |
Timespan that is considered night and/or weekend |
| |
OffNetworkRoaming |
Cost per minute when calling while roaming |
| |
ActivationFee |
Cost to activate a phone with this service plan |
| |
TerminationFee |
For postpaid plans this is the cost to terminate the contract ahead of its expiration |
| |
DirectoryFee |
Per-call charge for getting directory assistance |
| |
CallTraceFee |
Per-call charge for tracing a call |
| |
Deposit |
Information on credit/deposit requirements to be eligable for this plan |
| |
Features/ |
Contains grouped attribute elements that describe the plans included and optional calling features. |
|
|