Passing multiple parameters to the Element API

Question

How should I go about passing multiple parameters to the Element API?

The scenario is that I would like to display all my categories for a given section in a form, and allow the user to select categories, and send them to the API. I would like to receive back a json object of all the entries that have the categories assigned.

I am aware that I can dynamically catch url segments, but I'm not understanding how I would pass something like a GET parameter as a segment.

Thanks for the help!

Answer 1

You can fetch GET parameters using HttpRequestService::getQuery() or getRequiredQuery():

'entries-by-category' => function() {
    $categoryIds = craft()->request->getRequiredQuery('categoryIds');

    return [
        'elementType' => 'Entry',
        'criteria' => [
            'relatedTo' => ['targetElement' => $categoryIds],
        ],
        // ...
    ];
},

Answer 2

For those curious how to make sure that all categories match (and instead of or):

'entries-by-category' => function() {
    $categoryIds = craft()->request->getRequiredQuery('categoryIds');

    return [
        'elementType' => 'Entry',
        'criteria' => [
            'relatedTo' => ['targetElement' => ['and', 123, 234, 567]
        ],
        // ...
    ];
},

You can even have more related conditions going on and add the and relationship as well like that:

'entries-by-category' => function() {
    $categoryIds = craft()->request->getRequiredQuery('categoryIds');

    return [
        'elementType' => 'Entry',
        'criteria' => [
            'relatedTo' => [
                'and',
                ['targetElement' => ['and', 22, 33]],
                ['targetElement' => ['and', 123, 234]]
            ]
        ],
        // ...
    ];
},