Query Options 3 modified by Kola Oyewumi

Kola Oyewumi — Sun, 18 Dec 2016 17:24:09 -0000

Basic Usage

This sample usage shows how to read "Accounts" module entity collection data with query. Both "query" and "query predicates" as set, but the predicates are ignored. For more request options make changes to the Options parameter.

This implements the get_entry_list SugarCRM REST API method setting the query parameter.

using SugarRestSharp;

string url = "http://191.101.224.189/sugar/service/v4_1/rest.php";
string username = "will";
string password = "will";

var client = new SugarRestClient(url, username, password);

var request = new SugarRestRequest(RequestType.BulkRead);

request.Options.Query = "accounts.name = 'Air Safety Inc' ";
request.Options.QueryPredicates = new List<QueryPredicate>();
request.Options.QueryPredicates.Add(new QueryPredicate(nameof(Account.Name), QueryOperator.Equal, "General Electric USA, Inc"));

SugarRestResponse response = await client.ExecuteAsync<Account>(request);

Response (Data)

List<Account> accounts = (List<Account>) response.Data;

Response (JData)

[
  {
    "assigned_user_name": "Sarah Smith",
    "modified_by_name": "Administrator",
    "created_by_name": "Administrator",
    "id": "481407cb-28b7-ab8f-28f0-5777b598e42e",
    "name": "Air Safety Inc",
    "date_entered": "2016-07-02 12:36:44",
    "date_modified": "2016-07-02 12:36:44",
    "modified_user_id": "1",
    "created_by": "1",
    "description": "",
    "deleted": "0",
    "assigned_user_id": "seed_sarah_id",
    "account_type": "Customer",
    "industry": "Education",
    "annual_revenue": "",
    "phone_fax": "",
    "billing_address_street": "123 Anywhere Street",
    "billing_address_street_2": "",
    "billing_address_street_3": "",
    "billing_address_street_4": "",
    "billing_address_city": "Sunnyvale",
    "billing_address_state": "CA",
    "billing_address_postalcode": "71939",
    "billing_address_country": "USA",
    "rating": "",
    "phone_office": "(604) 049-5766",
    "phone_alternate": "",
    "website": "www.kidsales.name",
    "ownership": "",
    "employees": "",
    "ticker_symbol": "",
    "shipping_address_street": "123 Anywhere Street",
    "shipping_address_street_2": "",
    "shipping_address_street_3": "",
    "shipping_address_street_4": "",
    "shipping_address_city": "Sunnyvale",
    "shipping_address_state": "CA",
    "shipping_address_postalcode": "71939",
    "shipping_address_country": "USA",
    "email1": "beans.dev.qa@example.net",
    "email_addresses_non_primary": "",
    "parent_id": "",
    "sic_code": "",
    "parent_name": "",
    "email_opt_out": "0",
    "invalid_email": "0",
    "email": "",
    "campaign_id": "",
    "campaign_name": ""
  },
  {
    "assigned_user_name": "Sarah Smith",
    "modified_by_name": "Administrator",
    "created_by_name": "Administrator",
    "id": "6b1d1ada-00af-1a47-73fd-5777b548a6a2",
    "name": "Air Safety Inc",
    "date_entered": "2016-07-02 12:36:44",
    "date_modified": "2016-07-02 12:36:44",
    "modified_user_id": "1",
    "created_by": "1",
    "description": "",
    "deleted": "0",
    "assigned_user_id": "seed_sarah_id",
    "account_type": "Customer",
    "industry": "Telecommunications",
    "annual_revenue": "",
    "phone_fax": "",
    "billing_address_street": "48920 San Carlos Ave",
    "billing_address_street_2": "",
    "billing_address_street_3": "",
    "billing_address_street_4": "",
    "billing_address_city": "Salt Lake City",
    "billing_address_state": "CA",
    "billing_address_postalcode": "10029",
    "billing_address_country": "USA",
    "rating": "",
    "phone_office": "(839) 074-3293",
    "phone_alternate": "",
    "website": "www.salesqa.tw",
    "ownership": "",
    "employees": "",
    "ticker_symbol": "",
    "shipping_address_street": "48920 San Carlos Ave",
    "shipping_address_street_2": "",
    "shipping_address_street_3": "",
    "shipping_address_street_4": "",
    "shipping_address_city": "Salt Lake City",
    "shipping_address_state": "CA",
    "shipping_address_postalcode": "10029",
    "shipping_address_country": "USA",
    "email1": "sales.im.qa@example.biz",
    "email_addresses_non_primary": "",
    "parent_id": "",
    "sic_code": "",
    "parent_name": "",
    "email_opt_out": "0",
    "invalid_email": "0",
    "email": "",
    "campaign_id": "",
    "campaign_name": ""
  }
]

Response (JsonRawRequest)

{
  "resource": "",
  "parameters": [
    {
      "name": "method",
      "value": "get_entry_list",
      "type": "GetOrPost"
    },
    {
      "name": "input_type",
      "value": "json",
      "type": "GetOrPost"
    },
    {
      "name": "response_type",
      "value": "json",
      "type": "GetOrPost"
    },
    {
      "name": "rest_data",
      "value": "{\"session\":\"1l112qlpnupq7okfilru3nfft4\",\"module_name\":\"Accounts\",\"query\":\" accounts.name = 'Air Safety Inc' \",\"order_by\":\"\",\"offset\":0,\"select_fields\":[],\"link_name_to_fields_array\":\"\",\"max_results\":100,\"deleted\":0,\"favorites\":false}",
      "type": "GetOrPost"
    },
    {
      "name": "Accept",
      "value": "application\/json, application\/xml, text\/json, text\/x-json, text\/javascript, text\/xml",
      "type": "HttpHeader"
    }
  ],
  "method": "POST",
  "uri": "http:\/\/191.101.224.189\/sugar\/service\/v4_1\/rest.php"
}

Response (JsonRawResponse)