Profile: social-handle

Profile Schema

The social-handle profile specifies a platform and a handle for defining a social media platform presence.

The social-handle profile is intended to be used as a type profile.

Structure

The social-handle profile specifies two required attributes, platform and handle. These respectively define an enum-bounded string of possible platform options and a string representing the relevant handle on that platform.

The social-handle profile specifies a number of attributes:

  • platform - An enum-bounded string of possible platform options. Valid options include:
    • facebook
    • twitter
    • pinterest
    • instagram
    • tumblr
  • handle - A string value for the handle used on the specified platform.

Example social-handle document

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

  "platform": "tumblr",
  "handle": "darth-vader",
}

© 2024 npr