Home | Index

Address Book XML/JSON API Developer Guide

Chapter 1. Introduction — Next

Address Book XML/JSON API Developer Guide

Copyright © 2008, Yahoo! Inc.

Abstract

The Address Book Developer Guide contains information for Address Book developers.

For developer assistance with Address Book, join the Address Book Yahoo! Group for Developers.

Table of Contents

1. Introduction
Overview
Endpoint URLs
Endpoint URL Syntax
Making the Request
Transport Protocol
Request Content-Type
2. Interacting with the Address Book
Searching the Address Book
Parameters
Contact Criteria
Display Criteria
Paging
Bucketing
Getting the List of Categories
Adding Information to the Address Book
Add Conditions
Contact was not valid
Contact was added without duplication
Contact was merged with an existing contact
Examples
Synchronizing the Address Book
Synchronize Request
Contact ID, Field ID and Category ID
ADD-CONTACT
Add Contact Response Conditions
UPDATE-CONTACT
REMOVE-CONTACT
ADD-CATEGORY
RENAME-CATEGORY
REMOVE-CATEGORY
Synchronize Response
Interaction Diagrams
Example (JSON)
Example (XML)
Updating individual contacts in the Address Book
Example using XML
Example using JSON
3. Reference Guide
Data Representation
Request and Response Entities
Representing Fields
Structured Fields
Unstructured Fields
Field Flags
Representing Categories
Examples
Field Value Normalization
Data Formats
XML
Example
XML Versioning and Validation
JSON Format
Example
Authentication
User Authentication
Application Authentication
General Validity Constraints
Error Reporting
Structured Error Responses
Retrying Requests
Address Book XML/JSON API Error Codes
Examples
XML
JSON
Internationalization
Character Encoding
Examples
URL Encoding
Error Messages

List of Tables

1.1. Endpoint URL Parameters
1.2. Request Content-Type
2.1. Contact Criteria
2.2. Criteria Types
2.3. Example Criteria Types
2.4. Display Criteria
2.5. Paging Parameters
2.6. Bucketing Parameters
2.7. Bucketing Response Items
2.8. Synchronization Events
2.9. Synchronization Request IDs
2.10. Synchronization Response IDs
2.11. Update-Contact Event Blocks
3.1. Top-Level Request Entities
3.2. Top-Level Response Entities
3.3. Child Entities
3.4. Name Field Sub-Field
3.5. Address Field Sub-Field
3.6. Birthday and Anniversary Field Sub-Field
3.7. Unstructured Fields
3.8. Field Flags
3.9. HTTP Status Codes
3.10. Structured Error Response Fields
3.11. Address Book XML/JSON API Error Codes