API Reference‎ > ‎People Service‎ > ‎

Resource: `shares`

A collection of shared profiles made by a person.

Schema

{
  "_type": "shares",
  "count": {number},
  "totalCount": {number},
  "page": {number},
  "pageCount": {number},
  "startIndex": {number},
  "endIndex": {number},
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
person Link to the associated person.
prev Link to the previous page of results.
next Link to the next page of results.
items Array of links to the request items.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes Username of the associated person.

Action: get

Fetches the collection of requests.

Request Parameters
Parameter Type Location Required Description
embed string query no Embedded links will be included in the response instead of linked
Options: items
page int query no The page number to return
Default: 1 Min: 1
limit int query no The number of requests to return per page
Default: 10 Min: 1 Max: 100
Response

If successful, a shares resource will be returned in the response body.


Action: post

Creates a new shared profile.

Request

A share resource is expected in the request body.

Response

If successful, a share resource will be returned in the response body.


Action: preview

Returns profile information that will be displayed to the recipient of the shared profile.

Request

A share resource is expected in the request body.

Response
TODO: Add response

Comments