** Default: 5
** Maximum: 15 (can be raised by '''entries''' get parameter)
* The attributes returned for each individual resource are presently the same as when querying the corresponding resource collection.
= stoney core: search resource methods =
== Global Search (GET) ==
Also visit [[stoney core: Search Resource Mapping (REST - LDAP)]] and [[stoney core: Global Searches]].
To form a global fulltext search (over all resources), append the url query parameter '''q''' with the desired search text: <code>https://api.example.com/v1/search?q=example</code>.
"isCompany": true,
"isActive": true,
"resellerName": "Example Reseller Ltd", "countryCode": "CH", "postalCode": "3012", "localityName": "Bern"
},
{ "id": 4000001,
"isCompany": true,
"isActive": true,
"resellerName": "Example Reseller No 2 Ltd", "countryCode": "CH", "postalCode": "8004", "localityName": "Zürich"
}
],
"isCompany": true,
"isActive": true,
"customerName": "Example Customer Ltd" "countryCode": "CH", "postalCode": "3012", "localityName": "Bern", "belongsToResellerID": 4000000
},
{ "id": 5000001, "location": "https://api.example.. com/v1/customers/5000001", "isCompany": false, "isActive": true, "customerName": "Peter Example" "countryCode": "CH", "postalCode": "3012", "localityName": "Bern", "belongsToResellerID": 4000001 }
],
"location": "https://api.example.com/v1/customers/?q=example"
},
"people":
{
"resources":
[
{ "id": 6000000,
"location": "https://api.example.com/v1/people/6000000",
"isActive": true,
"givenName": "Peter",
"surname": "Example"
"customerName": "Example Customer Ltd",
"belongsToResellerID": 4000000,
"belongsToCustomerID": 5000000
},
{ "id": 6000001,
"location": "https://api.example.com/v1/people/6000001",
"isActive": true,
"givenName": "Thomas",
"surname": "Example"
"customerName": "Example Customer Ltd",
"belongsToResellerID": 4000000,
"belongsToCustomerID": 5000000
},
],
"location": "https://api.example.com/v1/people/?q=example"
},
...
|}
== Global Search Response Object (stoney core: ResellersResource) ==The logic is described on the [[stoney core: Search Resource Mapping (REST - LDAP)]] page under the chapter [[stoney_core:_Search_Resource_Mapping_(REST_-_LDAP)#Global_Search_Response_Object_.28stoney_core:_Resellers_Resource.29 | Global Search Response Object (stoney core: Resellers Resource)]]. Resource collection object for resellersthe stoney core:Resellers Resource.
<source lang='javascript'>
{
"resellers":
{
"isCompany": true,
"isActive": true,
"resellerName": "Example Reseller Ltd", "countryCode": "CH", "postalCode": "3012", "localityName": "Bern"
},
{ "id": 4000001,
"isCompany": true,
"isActive": true,
"resellerName": "Example Reseller No 2 Ltd", "countryCode": "CH", "postalCode": "8004", "localityName": "Zürich"
}
],
</source>
== Global Search Response Object (stoney core: CustomersResource) ==The logic is described on the [[stoney core: Search Resource Mapping (REST - LDAP)]] page under the chapter [[stoney_core:_Search_Resource_Mapping_(REST_-_LDAP)#Global_Search_Response_Object_.28stoney_core:_Customers_Resource.29 | Global Search Response Object (stoney core: Customers Resource)]]. Resource collection object for the stoney core: Customers Resource.
<source lang='javascript'>
"customers":
"isCompany": true,
"isActive": true,
"customerName": "Example Customer Ltd" "countryCode": "CH", "postalCode": "3012", "localityName": "Bern", "belongsToResellerID": 4000000
},
{ "id": 5000001, "location": "https://api.example.. com/v1/customers/5000001", "isCompany": false, "isActive": true, "customerName": "Peter Example" "countryCode": "CH", "postalCode": "3012", "localityName": "Bern", "belongsToResellerID": 4000001 }
],
"location": "https://api.example.com/v1/customers/?q=example"
</source>
== Global Search Response Object (stoney core: PeopleResource) ==The logic is described on the [[stoney core: Search Resource Mapping (REST - LDAP)]] page under the chapter [[stoney_core:_Search_Resource_Mapping_(REST_-_LDAP)#Global_Search_Response_Object_.28stoney_core:_People_Resource.29 | Global Search Response Object (stoney core: People Resource)]]. Resource collection object for the stoney core: People Resource.
<source lang='javascript'>
"people":
"resources":
[
{ "id": 50000006000000, "location": "https://api.example.com/v1/customerspeople/6000000", "isActive": true, "givenName": "Peter", "surname": "Example" "customerName": "Example Customer Ltd", "belongsToResellerID": 4000000, "belongsToCustomerID": 5000000 }, { "id": 6000001, TBD"location": "https://api.example.com/v1/people/6000001", TBD"isActive": true, TBD"givenName": "Thomas", "surname": "Example" "customerName": "Example Customer Ltd", "belongsToResellerID": 4000000, "belongsToCustomerID": 5000000
},
{ "id": 6000001, ... }
],
"location": "https://api.example.com/v1/people/?q=example"