GET /v2/users/:user_id/notes
Return all the notes of the given User
GET /v2/campus/:campus_id/notes
Return all the notes of the given Campus
GET /v2/notes
Return all the notes
live_help Notes
chrome_reader_mode
This resource is paginated by 30 items
assignment_ind
This action requires a token resource owner
or an application with one of theses role(s):
Notes manager
, Advanced notes manager
.
settings Params
Param name | Description |
---|---|
user_id |
optional
. Must be String
The user id or slug |
campus_id |
optional
. Must be String
The campus id or slug |
sort |
optional
. Must be one of: id , user_id , from , subject , content , created_at , updated_at , kind , approved_at , approver_id , from_user_id .
The sort field. Sorted by created_at desc, id desc by default. MoreExample:To sort on notes on the fields approver_id on a descending order and from_user_id on a ascending order: ...&sort=-approver_id,from_user_id |
filter |
optional
. Must be one of: id , user_id , from , subject , content , created_at , updated_at , kind , approved_at , approver_id , from_user_id , approved .
Filtering on one or more fields MoreExample:
To filter on notes with the
...&filter[id]=a_value,another_value Filterable fields:
|
range |
optional
. Must be one of: id , user_id , from , subject , content , created_at , updated_at , kind , approved_at , approver_id , from_user_id .
Select on a particular range MoreExample:
To range on notes with the
...&range[from_user_id]=min_value,max_value Rangeable fields:
|
page |
optional
. Must be a Hash
The pagination params, as a hash |
page[number] |
optional
. Must be Fixnum
The current page |
page[size] |
optional
. Must be Fixnum
The number of items per page, defaults to 30, maximum 100 |
Examples
GET /v2/notes?page=1
200
[
{
"id": 1,
"from_user": {
"id": 74,
"login": "andre",
"url": "https://api.intra.42.fr/v2/users/andre"
},
"subject": "Chevelure abondante",
"content": "Mathieu n'aime pas se faire appeler princesse ♥️",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
}
},
{
"id": 2,
"from_user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
},
"subject": "Amour caché",
"content": "Est secretement amoureux de flav️",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 74,
"login": "andre",
"url": "https://api.intra.42.fr/v2/users/andre"
}
},
{
"id": 3,
"from_user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
},
"subject": "Amour caché (2)",
"content": "Est secretement amoureux de andré",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 10935,
"login": "fguilloc",
"url": "https://api.intra.42.fr/v2/users/fguilloc"
}
}
]
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/notes?page=1"
[
{
"id": 1,
"from_user": {
"id": 74,
"login": "andre",
"url": "https://api.intra.42.fr/v2/users/andre"
},
"subject": "Chevelure abondante",
"content": "Mathieu n'aime pas se faire appeler princesse ♥️",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
}
},
{
"id": 2,
"from_user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
},
"subject": "Amour caché",
"content": "Est secretement amoureux de flav️",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 74,
"login": "andre",
"url": "https://api.intra.42.fr/v2/users/andre"
}
},
{
"id": 3,
"from_user": {
"id": 22,
"login": "mathieu",
"url": "https://api.intra.42.fr/v2/users/mathieu"
},
"subject": "Amour caché (2)",
"content": "Est secretement amoureux de andré",
"created_at": "2016-04-27T07:26:38.254Z",
"user": {
"id": 10935,
"login": "fguilloc",
"url": "https://api.intra.42.fr/v2/users/fguilloc"
}
}
]
require "oauth2"
UID = "Your application uid"
SECRET = "Your application secret"
client = OAuth2::Client.new(UID, SECRET, site: "https://api.intra.42.fr")
token = client.client_credentials.get_token
response = token.get("/v2/notes?page=1")
response.status
# => 200
response.parsed
# => [{"id"=>1, "from_user"=>{"id"=>74, "login"=>"andre", "url"=>"https://api.intra.42.fr/v2/users/andre"}, "subject"=>"Chevelure abondante", "content"=>"Mathieu n'aime pas se faire appeler princesse ♥️", "created_at"=>"2016-04-27T07:26:38.254Z", "user"=>{"id"=>22, "login"=>"mathieu", "url"=>"https://api.intra.42.fr/v2/users/mathieu"}}, {"id"=>2, "from_user"=>{"id"=>22, "login"=>"mathieu", "url"=>"https://api.intra.42.fr/v2/users/mathieu"}, "subject"=>"Amour caché", "content"=>"Est secretement amoureux de flav️", "created_at"=>"2016-04-27T07:26:38.254Z", "user"=>{"id"=>74, "login"=>"andre", "url"=>"https://api.intra.42.fr/v2/users/andre"}}, {"id"=>3, "from_user"=>{"id"=>22, "login"=>"mathieu", "url"=>"https://api.intra.42.fr/v2/users/mathieu"}, "subject"=>"Amour caché (2)", "content"=>"Est secretement amoureux de andré", "created_at"=>"2016-04-27T07:26:38.254Z", "user"=>{"id"=>10935, "login"=>"fguilloc", "url"=>"https://api.intra.42.fr/v2/users/fguilloc"}}]