Profile: has-social-handles

Profile Schema

The has-social-handles profile designates a document that contains social-handles. While any document can contain social-handle assets without the has-social-handles profile, clients looking for social-handles within a document will likely target the socialHandles array provided by this profile, so it is highly recommended that a document with social-handles lists a has-social-handles profile.

Structure

has-social-handles specifies one required attribute: socialHandles. socialHandles is an array of links to social-handles used by this document. The social-handle links in this list may optionally contain rels. Valid and relatively self-explanatory rel values for these links are listed below; other values will be rejected:

• facebook
• twitter
• pinterest
• instagram
• tumblr

socialHandles must contain one or more links; all links must be asset links beginning with #/.

Example has-social-handles document

{
    "id": "12345",
    "profiles": [
        {
            "href": "/v1/profiles/has-social-handles"
        },
        {
            "href": "/v1/profiles/document"
        }
    ],

    "assets": {
        "5678": {
            "id": "5678",
            "profiles": [
                {
                    "href": "/v1/profiles/social-handle",
                    "rels": ["type"]
                }
            ],

            "platform": "facebook",
            "handle": "ben-kenobi-5"
        },

        "socialHandles": [
            {
                "href": "#/assets/5678",
                "rels": ["facebook"]
            }
        ]
    }
}