Description
Fetches the Wishlist.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customerid | Integer | Optional | Customer ID of the Customer for whom the Wishlist is to be fetched |
| resellerid | Integer | Optional | Reseller ID of the Reseller for whom the Wishlist is to be fetched |
| domain | Array of Strings | Optional | Domain Name(s) for which the Wishlist is to be fetched |
| tld | Array of Strings | Optional | TLD(s) for which the Wishlist is to be fetched |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of Wishlist entries whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of Wishlist entries whose Creation Date is less than creation-date-end |
| no-of-records | Integer | Required | Number of records to be returned |
| page-no | Integer | Required | Page number for which records are required |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/domains/preordering/fetch.xml?auth-userid=0&api-key=key&no-of-records=10&page-no=1
Response
Returns a hash map containing the below details:
-
Fetch Wishlist Action Status (status)
-
Fetch Wishlist Action Status Description (status_description)
-
Wishlist Details (response_value)
-
Domain Name (domainname)
-
TLD associated with the Domain Name (tld)
-
Category under which the TLD is included (category)
-
Wishlist Entry Creation Time (creation_time)
-
Customer ID of the Customer under whom the Wishlist exists (customerid)
-
Reseller ID of the Reseller under whom the Wishlist exists (resellerid)
-
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.