API Reference‎ > ‎People Service‎ > ‎

Resource: `invites`

A collection of invitations that have been sent from a person to others to join REPP.

Schema

{
  "_type": "invites",
  "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 person associated with the criminal check.
prev Link to the previous page of results.
next Link to the next page of results.
items Array of links to the invite 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 invites.

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 invites to return per page
Default: 10 Min: 1 Max: 100
Response

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


Action: post

Adds an invite.

Request

A invite resource is expected in the request body.

Response

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


Comments