Notes API

List notes

GET /note
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:

  • id

The following scopes are needed:

  • note_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 333
Content-Type: application/json
[
  {
    "id": 3,
    "user_id": 1,
    "event_start": "2013-01-19 14:00:00",
    "subject": "Passwortinformationen",
    "info": null,
    "contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null
  },
  {
    "id": 4,
    "user_id": 1,
    "event_start": "2013-01-16 14:20:00",
    "subject": "API conception",
    "info": "",
    "contact_id": 1,
    "project_id": null,
    "entry_id": null,
    "module_id": null
  }
]

Search notes

POST /note/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "subject",
    "value": "Passwort"
  }
]
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 Required Type Description
event_start optional string
contact_id optional string
user_id optional string
subject optional string
module_id optional string
entry_id optional string

The following scopes are needed:

  • note_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 173
Content-Type: application/json
[
  {
    "id": 3,
    "user_id": 1,
    "event_start": "2013-01-19 14:00:00",
    "subject": "Passwortinformationen",
    "info": null,
    "contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null
  }
]

Show note

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

The following scopes are needed:

  • note_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 171
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "event_start": "2013-01-19 14:00:00",
  "subject": "Passwortinformationen",
  "info": null,
  "contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null
}

Create note

POST /note
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "contact_id": 1
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
event_start required datetime (Format yyyy-mm-dd hh:ii:ss)
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project

The following scopes are needed:

  • note_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 159
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "info": "",
  "contact_id": 1,
  "project_id": null,
  "entry_id": null,
  "module_id": null
}

Overwrite note

PUT /note/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "contact_id": 1
}
Name Required Type Description
callback optional string
Name Required Type Description
event_start required datetime (Format yyyy-mm-dd hh:ii:ss)
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project

The following scopes are needed:

  • note_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 159
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "info": "",
  "contact_id": 1,
  "project_id": null,
  "entry_id": null,
  "module_id": null
}

Edit note

POST /note/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "contact_id": 1
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
event_start optional datetime (Format yyyy-mm-dd hh:ii:ss)
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project
subject optional string (150)
user_id optional Resource user

The following scopes are needed:

  • note_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 159
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "event_start": "2013-01-16 14:20:00",
  "subject": "API conception",
  "info": "",
  "contact_id": 1,
  "project_id": null,
  "entry_id": null,
  "module_id": null
}

Delete note

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

The following scopes are needed:

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