Agendize Client API

Notes


Resource representation

{ "id": {string}, "clientId": {string}, "html": {string}, "writer": { "email": {string}, "firstName": {string}, "lastName": {string} }, "date": { "dateTime": {datetime}, "timeZone": {string} }, "selfLink": {string} }
Parameter name Value Description
id string Identifier of the note.
clientId string Identifier of the client.
html string Html content of the note.
date object The date time of the note.
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
writer object Writer of the notes.
writer.email string Account email of the user.
writer.firstName string First Name of the user.
writer.lastName string Last Name of the user.
selfLink string URL link to the note resource description.

Dlete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
noteId string Note identifier.
Required query parameters
apiKey string API Key

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
noteId string Note identifier.
Required query parameters
apiKey string API Key

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Note resource in the response body.


List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/notes

Parameters

Parameter name Value Description
Required query parameters
apiKey string API Key
Optional query parameters
clientId string Identifier of the client.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Note Resource] }

Insert

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/notes

Parameters

Parameter name Value Description
Required query parameters
apiKey string API Key

Request body

In the request body, supply a Note Resource with the following properties:

Parameter name Value Description
Required Properties
clientId string Identifier of the client.
clientId string Identifier of the client.
html string Html content of the note.
Optional Properties
writer object Writer of the notes.
writer.email string Account email of the user.

Response

If successful, this method returns a Note resource in the response body.


Update

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
clientId string Note identifier.
Required query parameters
apiKey string API Key

Request body

In the request body, supply a Note resource with the following properties:

Parameter name Value Description
Optional Properties
html string Html content of the note.
writer object Writer of the notes.
writer.email string Account email of the user.

Response

If successful, this method returns a Note resource in the response body.