Titles API

List titles

GET /title
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • name
  • id

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 74
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Dr."
  },
  {
    "id": 2,
    "name": "Prof."
  },
  {
    "id": 3,
    "name": "Dr. med."
  }
]

Search titles

POST /title/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "name",
    "value": "Prof."
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • name
Name Required Type Description
name optional string

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 25
Content-Type: application/json
[
  {
    "id": 2,
    "name": "Prof."
  }
]

Show title

GET /title/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 22
Content-Type: application/json
{
  "id": 4,
  "name": "Prof"
}

Create title

POST /title
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Prof"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name required string (60)

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 22
Content-Type: application/json
{
  "id": 4,
  "name": "Prof"
}

Overwrite title

PUT /title/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Prof"
}
Name Required Type Description
callback optional string
Name Required Type Description
name required string (60)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 22
Content-Type: application/json
{
  "id": 4,
  "name": "Prof"
}

Edit title

POST /title/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Dr. med."
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name optional string (60)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 26
Content-Type: application/json
{
  "id": 4,
  "name": "Dr. med."
}

Delete title

DELETE /title/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}