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": 122,
    "user_id": 124,
    "godfather_id": 39,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.790Z",
    "updated_at": "2017-11-22T13:42:12.796Z",
    "user": {
      "id": 124,
      "login": "hsolo2",
      "url": "https://api.intra.42.fr/v2/users/hsolo2"
    },
    "godfather": {
      "id": 39,
      "login": "anskywal",
      "url": "https://api.intra.42.fr/v2/users/anskywal"
    }
  },
  {
    "id": 121,
    "user_id": 116,
    "godfather_id": 15,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.779Z",
    "updated_at": "2017-11-22T13:42:12.786Z",
    "user": {
      "id": 116,
      "login": "mwindu2",
      "url": "https://api.intra.42.fr/v2/users/mwindu2"
    },
    "godfather": {
      "id": 15,
      "login": "mwindu",
      "url": "https://api.intra.42.fr/v2/users/mwindu"
    }
  },
  {
    "id": 120,
    "user_id": 123,
    "godfather_id": 96,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.769Z",
    "updated_at": "2017-11-22T13:42:12.774Z",
    "user": {
      "id": 123,
      "login": "chewbche",
      "url": "https://api.intra.42.fr/v2/users/chewbche"
    },
    "godfather": {
      "id": 96,
      "login": "wattwatt",
      "url": "https://api.intra.42.fr/v2/users/wattwatt"
    }
  }
]
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/patronages"

[
  {
    "id": 122,
    "user_id": 124,
    "godfather_id": 39,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.790Z",
    "updated_at": "2017-11-22T13:42:12.796Z",
    "user": {
      "id": 124,
      "login": "hsolo2",
      "url": "https://api.intra.42.fr/v2/users/hsolo2"
    },
    "godfather": {
      "id": 39,
      "login": "anskywal",
      "url": "https://api.intra.42.fr/v2/users/anskywal"
    }
  },
  {
    "id": 121,
    "user_id": 116,
    "godfather_id": 15,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.779Z",
    "updated_at": "2017-11-22T13:42:12.786Z",
    "user": {
      "id": 116,
      "login": "mwindu2",
      "url": "https://api.intra.42.fr/v2/users/mwindu2"
    },
    "godfather": {
      "id": 15,
      "login": "mwindu",
      "url": "https://api.intra.42.fr/v2/users/mwindu"
    }
  },
  {
    "id": 120,
    "user_id": 123,
    "godfather_id": 96,
    "ongoing": true,
    "created_at": "2017-11-22T13:42:12.769Z",
    "updated_at": "2017-11-22T13:42:12.774Z",
    "user": {
      "id": 123,
      "login": "chewbche",
      "url": "https://api.intra.42.fr/v2/users/chewbche"
    },
    "godfather": {
      "id": 96,
      "login": "wattwatt",
      "url": "https://api.intra.42.fr/v2/users/wattwatt"
    }
  }
]
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"=>122, "user_id"=>124, "godfather_id"=>39, "ongoing"=>true, "created_at"=>"2017-11-22T13:42:12.790Z", "updated_at"=>"2017-11-22T13:42:12.796Z", "user"=>{"id"=>124, "login"=>"hsolo2", "url"=>"https://api.intra.42.fr/v2/users/hsolo2"}, "godfather"=>{"id"=>39, "login"=>"anskywal", "url"=>"https://api.intra.42.fr/v2/users/anskywal"}}, {"id"=>121, "user_id"=>116, "godfather_id"=>15, "ongoing"=>true, "created_at"=>"2017-11-22T13:42:12.779Z", "updated_at"=>"2017-11-22T13:42:12.786Z", "user"=>{"id"=>116, "login"=>"mwindu2", "url"=>"https://api.intra.42.fr/v2/users/mwindu2"}, "godfather"=>{"id"=>15, "login"=>"mwindu", "url"=>"https://api.intra.42.fr/v2/users/mwindu"}}, {"id"=>120, "user_id"=>123, "godfather_id"=>96, "ongoing"=>true, "created_at"=>"2017-11-22T13:42:12.769Z", "updated_at"=>"2017-11-22T13:42:12.774Z", "user"=>{"id"=>123, "login"=>"chewbche", "url"=>"https://api.intra.42.fr/v2/users/chewbche"}, "godfather"=>{"id"=>96, "login"=>"wattwatt", "url"=>"https://api.intra.42.fr/v2/users/wattwatt"}}]