live_help Notes

assignment This action requires one of theses roles: Advanced tutor
chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
user_id optional . Must be String

The user id or slug

sort optional . Must be one of: id, user_id, godfather_id, ongoing, created_at, updated_at.

The sort field. Sorted by created_at desc by default.

Example:

To sort on patronages on the fields created_at on a descending order and updated_at on a ascending order:

...&sort=-created_at,updated_at

filter optional . Must be one of: id, user_id, godfather_id, ongoing, created_at, updated_at.

Filtering on one or more fields

Example:

To filter on patronages with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • user_id (standard field)
  • godfather_id (standard field)
  • ongoing (standard field)
  • created_at (standard field)
  • updated_at (standard field)
range optional . Must be one of: id, user_id, godfather_id, ongoing, created_at, updated_at.

Select on a particular range

Example:

To range on patronages with the updated_at field between min_value and max_value:

...&range[updated_at]=min_value,max_value

Rangeable fields:
  • id
  • user_id
  • godfather_id
  • ongoing
  • created_at
  • updated_at
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

comments powered by <span class='logo-disqus'>Disqus</span>
GET /v2/patronages
200
[
  {
    "id": 62,
    "user_id": 35,
    "godfather_id": 11,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.533Z",
    "updated_at": "2017-03-06T14:59:37.540Z",
    "user": {
      "id": 35,
      "login": "kren",
      "url": "https://api.intra.42.fr/v2/users/kren"
    },
    "godfather": {
      "id": 11,
      "login": "mwindu",
      "url": "https://api.intra.42.fr/v2/users/mwindu"
    }
  },
  {
    "id": 61,
    "user_id": 43,
    "godfather_id": 26,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.522Z",
    "updated_at": "2017-03-06T14:59:37.529Z",
    "user": {
      "id": 43,
      "login": "darsidio",
      "url": "https://api.intra.42.fr/v2/users/darsidio"
    },
    "godfather": {
      "id": 26,
      "login": "jbinks",
      "url": "https://api.intra.42.fr/v2/users/jbinks"
    }
  },
  {
    "id": 60,
    "user_id": 41,
    "godfather_id": 26,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.508Z",
    "updated_at": "2017-03-06T14:59:37.515Z",
    "user": {
      "id": 41,
      "login": "ki-aki-a",
      "url": "https://api.intra.42.fr/v2/users/ki-aki-a"
    },
    "godfather": {
      "id": 26,
      "login": "jbinks",
      "url": "https://api.intra.42.fr/v2/users/jbinks"
    }
  }
]
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/patronages"

[
  {
    "id": 62,
    "user_id": 35,
    "godfather_id": 11,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.533Z",
    "updated_at": "2017-03-06T14:59:37.540Z",
    "user": {
      "id": 35,
      "login": "kren",
      "url": "https://api.intra.42.fr/v2/users/kren"
    },
    "godfather": {
      "id": 11,
      "login": "mwindu",
      "url": "https://api.intra.42.fr/v2/users/mwindu"
    }
  },
  {
    "id": 61,
    "user_id": 43,
    "godfather_id": 26,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.522Z",
    "updated_at": "2017-03-06T14:59:37.529Z",
    "user": {
      "id": 43,
      "login": "darsidio",
      "url": "https://api.intra.42.fr/v2/users/darsidio"
    },
    "godfather": {
      "id": 26,
      "login": "jbinks",
      "url": "https://api.intra.42.fr/v2/users/jbinks"
    }
  },
  {
    "id": 60,
    "user_id": 41,
    "godfather_id": 26,
    "ongoing": true,
    "created_at": "2017-03-06T14:59:37.508Z",
    "updated_at": "2017-03-06T14:59:37.515Z",
    "user": {
      "id": 41,
      "login": "ki-aki-a",
      "url": "https://api.intra.42.fr/v2/users/ki-aki-a"
    },
    "godfather": {
      "id": 26,
      "login": "jbinks",
      "url": "https://api.intra.42.fr/v2/users/jbinks"
    }
  }
]
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/patronages")
response.status
# => 200
response.parsed
# => [{"id"=>62, "user_id"=>35, "godfather_id"=>11, "ongoing"=>true, "created_at"=>"2017-03-06T14:59:37.533Z", "updated_at"=>"2017-03-06T14:59:37.540Z", "user"=>{"id"=>35, "login"=>"kren", "url"=>"https://api.intra.42.fr/v2/users/kren"}, "godfather"=>{"id"=>11, "login"=>"mwindu", "url"=>"https://api.intra.42.fr/v2/users/mwindu"}}, {"id"=>61, "user_id"=>43, "godfather_id"=>26, "ongoing"=>true, "created_at"=>"2017-03-06T14:59:37.522Z", "updated_at"=>"2017-03-06T14:59:37.529Z", "user"=>{"id"=>43, "login"=>"darsidio", "url"=>"https://api.intra.42.fr/v2/users/darsidio"}, "godfather"=>{"id"=>26, "login"=>"jbinks", "url"=>"https://api.intra.42.fr/v2/users/jbinks"}}, {"id"=>60, "user_id"=>41, "godfather_id"=>26, "ongoing"=>true, "created_at"=>"2017-03-06T14:59:37.508Z", "updated_at"=>"2017-03-06T14:59:37.515Z", "user"=>{"id"=>41, "login"=>"ki-aki-a", "url"=>"https://api.intra.42.fr/v2/users/ki-aki-a"}, "godfather"=>{"id"=>26, "login"=>"jbinks", "url"=>"https://api.intra.42.fr/v2/users/jbinks"}}]