How do I use the Element API to search via entry title?

Question

I can't seem to find this anywhere. Thanks.

Update:

'api/entry/search.json' => function() {
    return [
        'elementType' => 'Entry',
        'criteria' => [
            'search' => (craft()->request->getParam('search')) ? craft()->request->getParam('search') : '' 
        ],
        'first' => true,
        'transformer' => function(EntryModel $entry) {
            return [
                'title' => $entry->title,
                'url' => $entry->url,
            ];
        },
    ];
},

Using the url: api/entry/search.json?search=title:test did not work.

This code works, but the title needs to be exact:

'api/entry/search.json' => function() {
    return [
        'elementType' => 'Entry',
        'criteria' => [
            'title' => craft()->request->getParam('title')
        ],
        'first' => true,
        'transformer' => function(EntryModel $entry) {
            return [
                'title' => $entry->title,
                'url' => $entry->url,
            ];
        },
    ];
},

Using this url: api/entry/search.json?title=Test%20Article, works, but not api/entry/search.json?title=Test

score 5 · Accepted Answer · edited Jun 02 '16 at 05:21

5

Following is an example of using the search feature in a GET request with parameter 'search'.

return [
    'elementType' => 'Entry',
    'criteria' => ['search' => (craft()->request->getParam('search')) ? 'title:'.craft()->request->getParam('search') : '' ],
    'paginate' => true,
    'elementsPerPage' => 10,
    'pageParam' => 'pg',
    'transformer' => new ListTransformer(),
];`

I assume you can use this instead of the custom transformer class that is being used in the above example:

'transformer' => function(EntryModel $entry) {
    return [
        'title' => $entry->title,
        'url' => $entry->url,
        'summary' => $entry->summary,
        'body' => $entry->body,
    ];
},

edited Jun 02 '16 at 05:21

Brad Bell

67,440
6
73
143

answered Jun 01 '16 at 13:57

Mark Watson

150
6

How would I use this in the URL? Like this: search.json?search=title:test ? – Erik Jun 01 '16 at 14:06
URL format is correct I haven't delved too deeply into search syntax for parameters like title:test mine is search.json?search=test that is global search – Mark Watson Jun 01 '16 at 14:16
The syntax for search=title:test is correct – Mark Watson Jun 01 '16 at 14:18
Hmm, ok. Doesn't seem to fetch anything. I will tinker with it. Thanks. – Erik Jun 01 '16 at 14:18
Try this title:"*test*" – Mark Watson Jun 01 '16 at 14:23
Negative, I updated with two different approaches I tried. – Erik Jun 01 '16 at 14:30
Let us continue this discussion in chat. – Erik Jun 01 '16 at 14:31

How do I use the Element API to search via entry title?

1 Answers1