relationships resource endpoint

URL: /relationships/<id>.<format>

Supported Methods

GET Get basic information about the selected relationship.

Resource Type

This endpoint returns an object of type Relationship.

created (map<datetime>)
A mapping of the relationship types present between the source and target objects to the times those types of relationship were established. The keys of the map are the relationship type URIs present in the relationship's status property; the values are W3CDTF timestamps for the times those relationship edges were created.
id (string)
A URI that serves as a globally unique identifier for the relationship.
source (Entity)
The source entity of the relationship.
status (RelationshipStatus)
An object describing all the types of relationship that currently exist between the source and target objects.
target (Entity)
The target entity of the relationship.
urlId (string)
A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same relationship is returned in response to different requests, and as a mapping key for an application's local data store.

Client Library Methods for PHP

Get basic information about the selected relationship.
$tp->relationships->get(array(

    # Required Parameters
    "id" => $id,

))

Property Endpoints

This endpoint has the following property endpoints:

status Get the status information for the selected relationship, including its types.

Example Request

GET /relationships/6r012877b13de7970c0120a8ae8949970b.json HTTP/1.1
Host: api.typepad.com

HTTP/1.0 200 OK
Content-type: application/json
Content-length: 1679

{
   "source": {
      "urlId": "6p012877b13de7970c",
      "location": null,
      "interests": [],
      "objectTypes": [
         "tag:api.typepad.com,2009:User"
      ],
      "profilePageUrl": "http://profile.typepad.com/loblawatlaw",
      "aboutMe": null,
      "objectType": "User",
      "preferredUsername": "loblawatlaw",
      "id": "tag:api.typepad.com,2009:6p012877b13de7970c",
      "avatarLink": {
         "width": 250,
         "urlTemplate": "http://static.typepad.com/.shared:ve698a40:typepad:en_us/default-userpics/11-{spec}.gif",
         "url": "http://static.typepad.com/.shared:ve698a40:typepad:en_us/default-userpics/11-250si.gif",
         "height": 250
      },
      "displayName": "Bob Loblaw"
   },
   "created": {},
   "urlId": "6r012877b13de7970c0120a8ae8949970b",
   "target": {
      "urlId": "6p0120a8ae8949970b",
      "location": null,
      "interests": [],
      "objectTypes": [
         "tag:api.typepad.com,2009:User"
      ],
      "profilePageUrl": "http://profile.typepad.com/matkinsdevin",
      "aboutMe": null,
      "objectType": "User",
      "preferredUsername": "matkinsdevin",
      "id": "tag:api.typepad.com,2009:6p0120a8ae8949970b",
      "avatarLink": {
         "width": 250,
         "urlTemplate": "http://static.typepad.com/.shared:ve698a40:typepad:en_us/default-userpics/08-{spec}.gif",
         "url": "http://static.typepad.com/.shared:ve698a40:typepad:en_us/default-userpics/08-250si.gif",
         "height": 250
      },
      "displayName": "Devin Jineer"
   },
   "status": {
      "types": []
   },
   "id": "tag:api.typepad.com,2009:6r012877b13de7970c0120a8ae8949970b"
}