OdooJsonRpcClient
Odoo Json RPC client for Android.
This project is developed against Odoo 10.0 Community Edition and it's compatible with Odoo 11.0. It may not work properly against older versions of Odoo.
Configure Odoo host address, Project website, Privacy policy and Contact email from configs.xml
Get the Odoo Json-rpc request collection for Postman (Right Click -> Save Link As... -> OdooJsonRpc.postman_collection.json).
While changing the applicationId
, perform the corresponding changes at android:accountType
inside authenticator.xml as well as at Gson's Proguard Rules inside proguard-rules.pro.
Update tokenKey
inside AesSecretKey.kt as base for performing encryption / decryption of user's sensitive information
Do not hesitate to report issues you may find.
Get the sample APK from release section.
Next Milestone:
- Synchronization and Persistence using Room Persistence Library
How to use
Odoo specific methods can be access using singleton object Odoo
. Login Account related functionality can be access using Context
's Extension functions. Authentication
as well as Sessions
are managed inside application's core
module. You should not use any session
related methods anywhere in application, It may lead to unexpected behaviour of application.
Odoo specific methods are following:
Create
Creates a new record for the model.
Request
Odoo.create(model = "res.partner", values = mapOf(
"name" to "Kasim Rangwala", "email" to "rangwalakasim@live.in"
)) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val create = response.body()!!
if (create.isSuccessful) {
val result = create.result
// ...
} else {
// Odoo specific error
Timber.w("create() failed with ${create.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": 45
}
Read
Reads the requested fields for the records
Request
Odoo.read(model = "res.partner", ids = listOf(1, 3), fields = listOf("id", "name", "email")) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val read = response.body()!!
if (read.isSuccessful) {
val result = read.result
// ...
} else {
// Odoo specific error
Timber.w("read() failed with ${read.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
{
"email": "info@yourcompany.example.com",
"id": 1,
"name": "YourCompany"
},
{
"email": "admin@yourcompany.example.com",
"id": 3,
"name": "Administrator"
}
]
}
Write
Updates all records in the current ids
with the provided values.
Request
Odoo.write(model = "res.partner", ids = listOf(45, 46),
values = mapOf("name" to "Kasim3 Rangwala1", "email" to "rangwalakasim@live.in")) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val write = response.body()!!
if (write.isSuccessful) {
val result = write.result
// ...
} else {
// Odoo specific error
Timber.w("write() failed with ${write.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": true
}
Unlink
Deletes the records of the current ids
Request
Odoo.unlink(model = "res.partner", ids = listOf(47, 48)) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val unlink = response.body()!!
if (unlink.isSuccessful) {
val result = unlink.result
// ...
} else {
// Odoo specific error
Timber.w("unlink() failed with ${unlink.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": true
}
Search
Searches for records based on the following arguments
- domain: Use an empty list to match all records.
- offset: number of results to ignore (default:
0
) - limit: maximum number of records to return (default: all)
- sort: order string
- count: if
true
, only counts and returns the number of matching records (default:false
)
returns: at most limit
records matching the search criteria
Request
Odoo.search(model = "res.partner", domain = listOf(listOf("name", "ilike", "Demo")),
offset = 0, limit = 0, sort = "", count = false) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val search = response.body()!!
if (search.isSuccessful) {
val result = search.result
// ...
} else {
// Odoo specific error
Timber.w("search() failed with ${search.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
44,
6
]
}
SearchRead
Performs a search()
followed by a read()
.
- domain: Search domain, see arguments in
search
. Defaults to an empty domain that will match all records. - fields: List of fields to read, see
fields
parameter inread
. Defaults to all fields. - offset: Number of records to skip, see
offset
parameter insearch
. Defaults to0
. - limit: Maximum number of records to return, see
limit
parameter insearch
. Defaults to no limit. - sort: Columns to sort result, see
sort
parameter insearch
. Defaults to no sort.
return: List of objects containing the asked fields.
Request
Odoo.searchRead(model = "res.partner", fields = listOf(
"id", "name", "email", "company_name"
), domain = listOf(listOf("customer", "=", true)), offset = 0, limit = 4, sort = "name ASC") {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val searchRead = response.body()!!
if (searchRead.isSuccessful) {
val result = searchRead.result
// use gson to convert records (jsonArray) to list of POJO
// ...
} else {
// Odoo specific error
Timber.w("searchRead() failed with ${searchRead.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"length": 25,
"records": [
{
"id": 9,
"name": "Agrolait",
"email": "agrolait@yourcompany.example.com",
"company_name": false
},
{
"id": 31,
"name": "Ayaan Agarwal",
"email": "ayaan.agarwal@bestdesigners.example.com",
"company_name": false
},
{
"id": 37,
"name": "Benjamin Flores",
"email": "benjamin.flores@nebula.example.com",
"company_name": false
},
{
"id": 13,
"name": "Camptocamp",
"email": "camptocamp@yourcompany.example.com",
"company_name": false
}
]
}
}
SearchCount
Returns the number of records in the current model matching the provided domain
.
Request
Odoo.searchCount(model = "res.partner", args = listOf(listOf("name", "ilike", "kasim rangwala"))) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val searchCount = response.body()!!
if (searchCount.isSuccessful) {
val result = searchCount.result
// ...
} else {
// Odoo specific error
Timber.w("searchCount() failed with ${searchCount.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": 2
}
NameGet
Returns a textual representation for the records in ids
. By default this is the value of the display_name
field.
return: list of pairs [id, text_repr]
for each records
Request
Odoo.nameGet(model = "res.partner", ids = listOf(1, 3)) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val nameGet = response.body()!!
if (nameGet.isSuccessful) {
val result = nameGet.result
// ...
} else {
// Odoo specific error
Timber.w("nameGet() failed with ${nameGet.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
[
1,
"YourCompany"
],
[
3,
"YourCompany, Administrator"
]
]
}
NameCreate
Create a new record by calling create
with only one value provided, the display name of the new record. The new record will be initialized with any default values applicable to this model, or provided through the context. The usual behavior of create
applies.
- name: display name of the record to create
return: the nameGet
pair value of the created record
Request
Odoo.nameCreate(model = "res.partner", name = "kasim") {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val nameCreate = response.body()!!
if (nameCreate.isSuccessful) {
val result = nameCreate.result
// ...
} else {
// Odoo specific error
Timber.w("nameCreate() failed with ${nameCreate.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
47,
"kasim"
]
}
NameSearch
Search for records that have a display name matching the given name
pattern when compared with the given operator
, while also matching the optional search domain (args
).
This is used for example to provide suggestions based on a partial value for a relational field. Sometimes be seen as the inverse function of nameGet
, but it is not guaranteed to be. This method is equivalent to calling search
with a search domain based on display_name
and then nameGet
on the result of the search.
- name: the name pattern to match
- args: optional search domain (see
search
for syntax), specifying further restrictions - operator: domain operator for matching
name
, such aslike
or=
. - limit: optional max number of records to return
return: list of pairs [id, text_repr]
for all matching records.
Request
Odoo.nameSearch(model = "res.partner", name = "Delta PC", args = listOf(), operator = "ilike", limit = 0) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val nameSearch = response.body()!!
if (nameSearch.isSuccessful) {
val result = nameSearch.result
// ...
} else {
// Odoo specific error
Timber.w("nameSearch() failed with ${nameSearch.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
[
11,
"Delta PC"
],
[
28,
"Delta PC, Charlie Bernard"
],
[
29,
"Delta PC, Jessica Dupont"
],
[
41,
"Delta PC, Kevin Clarke"
],
[
40,
"Delta PC, Morgan Rose"
],
[
17,
"Delta PC, Richard Ellis"
],
[
35,
"Delta PC, Robert Anderson"
],
[
39,
"Delta PC, Robin Smith"
]
]
}
CheckAccessRights
Verifies that the operation given by operation
is allowed for the current user according to the access rights.
- operation: one of
create
,read
,write
,unlink
. - raiseException: if
true
then it raiseAccessError
when current operation is not allowed according to the access rights.
return: true
if the operation is allowed
Request
Odoo.checkAccessRights(model = "res.users", operation = "unlink") {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val checkAccessRights = response.body()!!
if (checkAccessRights.isSuccessful) {
val result = checkAccessRights.result
// ...
} else {
// Odoo specific error
Timber.w("checkAccessRights() failed with ${checkAccessRights.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": false
}
CallKw
Calls the method of given model.
for @api.model
, avoid passing id
in args
.
callKw(model = "res.users", method = "has_group", args = listOf("base.group_user"))
for @api.multi
, pass list of id(s)
in args
.
callKw(model = "res.partner", method = "write", args = listOf(listOf(45, 46), mapOf("name" to "Kasim3 Rangwala1", "email" to "rangwalakasim@live.in")))
Request
Odoo.callKw(model = "res.users", method = "has_group", args = listOf("base.group_user")) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val callKw = response.body()!!
if (callKw.isSuccessful) {
val result = callKw.result
// ...
} else {
// Odoo specific error
Timber.w("callkw() failed with ${callKw.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": true
}
Load
Browse a record.
Request
Odoo.load(id = 1, model = "res.partner") {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val load = response.body()!!
if (load.isSuccessful) {
val result = load.result
// ...
} else {
// Odoo specific error
Timber.w("load() failed with ${load.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"value": {
"id": 1,
"name": "YourCompany",
"display_name": "YourCompany",
"date": false,
"title": false,
"parent_id": false,
"child_ids": [
42,
43
],
"ref": false,
"lang": "en_US",
"tz": false,
"user_id": false,
"vat": false,
"bank_ids": [
],
"website": "http://www.example.com",
"opportunity_count": 0,
"meeting_count": 0,
"__last_update": "2018-07-23 18:10:57"
}
}
}
Modules
Get installed modules
Request
Odoo.modules {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val modules = response.body()!!
if (modules.isSuccessful) {
val result = modules.result
// ...
} else {
// Odoo specific error
Timber.w("modules() failed with ${modules.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": [
"base",
"web",
"bus",
"web_tour",
"mail",
"sales_team",
"calendar",
"web_planner",
"contacts",
"crm",
"auth_signup",
"base_import",
"iap",
"sms",
"web_diagram",
"web_editor",
"web_kanban_gauge",
"web_settings_dashboard"
]
}
FieldsGet
Get fields data for the model.
Request
Odoo.fieldsGet(model = "res.partner", fields = listOf("name", "ttype", "modules", "relation", "relation_field", "relation_table", "required") /*or just listOf() for all detail*/) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val fieldsGet = response.body()!!
if (fieldsGet.isSuccessful) {
val result = fieldsGet.result
// ...
} else {
// Odoo specific error
Timber.w("fieldsGet() failed with ${fieldsGet.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"length": 88,
"records": [
{
"id": 877,
"name": "name",
"ttype": "char",
"relation": false,
"relation_field": false,
"relation_table": false,
"required": false,
"modules": "base"
},
{
"id": 908,
"name": "email",
"ttype": "char",
"relation": false,
"relation_field": false,
"relation_table": false,
"required": false,
"modules": "base"
},
{
"id": 907,
"name": "country_id",
"ttype": "many2one",
"relation": "res.country",
"relation_field": false,
"relation_table": false,
"required": false,
"modules": "base"
},
{
"id": 893,
"name": "category_id",
"ttype": "many2many",
"relation": "res.partner.category",
"relation_field": false,
"relation_table": "res_partner_res_partner_category_rel",
"required": false,
"modules": "base"
},
{
"id": 917,
"name": "user_ids",
"ttype": "one2many",
"relation": "res.users",
"relation_field": "partner_id",
"relation_table": false,
"required": false,
"modules": "base"
}
]
}
}
AccessGet
Get list of groups and their access rights.
Request
Odoo.accessGet(model = "res.partner", fields = listOf("name", "group_id", "perm_read", "perm_write", "perm_create", "perm_unlink") /*or just listOf() for all detail*/) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val accessGet = response.body()!!
if (accessGet.isSuccessful) {
val result = accessGet.result
// ...
} else {
// Odoo specific error
Timber.w("accessGet() failed with ${accessGet.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"length": 6,
"records": [
{
"id": 53,
"name": "res_partner group_public",
"group_id": [
11,
"Other Extra Rights / Public"
],
"perm_read": true,
"perm_write": false,
"perm_create": false,
"perm_unlink": false
},
{
"id": 54,
"name": "res_partner group_portal",
"group_id": [
10,
"Other Extra Rights / Portal"
],
"perm_read": true,
"perm_write": false,
"perm_create": false,
"perm_unlink": false
},
{
"id": 55,
"name": "res_partner group_partner_manager",
"group_id": [
8,
"Extra Rights / Contact Creation"
],
"perm_read": true,
"perm_write": true,
"perm_create": true,
"perm_unlink": true
},
{
"id": 56,
"name": "res_partner group_user",
"group_id": [
1,
"Employees / Employee"
],
"perm_read": true,
"perm_write": false,
"perm_create": false,
"perm_unlink": false
},
{
"id": 201,
"name": "res.partner.crm.manager",
"group_id": [
14,
"Sales / Manager"
],
"perm_read": true,
"perm_write": false,
"perm_create": false,
"perm_unlink": false
},
{
"id": 203,
"name": "res.partner.crm.user",
"group_id": [
12,
"Sales / User: Own Documents Only"
],
"perm_read": true,
"perm_write": true,
"perm_create": true,
"perm_unlink": false
}
]
}
}
GroupsGet
Get list of groups assigned to current user.
Request
Odoo.groupsGet(fields = listOf("name", "full_name", "display_name") /*or just listOf() for all detail*/) {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val groupsGet = response.body()!!
if (groupsGet.isSuccessful) {
val result = groupsGet.result
// ...
} else {
// Odoo specific error
Timber.w("groupsGet() failed with ${groupsGet.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"length": 8,
"records": [
{
"id": 3,
"name": "Access Rights",
"full_name": "Administration / Access Rights",
"display_name": "Administration / Access Rights"
},
{
"id": 8,
"name": "Contact Creation",
"full_name": "Extra Rights / Contact Creation",
"display_name": "Extra Rights / Contact Creation"
},
{
"id": 1,
"name": "Employee",
"full_name": "Employees / Employee",
"display_name": "Employees / Employee"
},
{
"id": 14,
"name": "Manager",
"full_name": "Sales / Manager",
"display_name": "Sales / Manager"
},
{
"id": 4,
"name": "Settings",
"full_name": "Administration / Settings",
"display_name": "Administration / Settings"
},
{
"id": 7,
"name": "Technical Features",
"full_name": "Extra Rights / Technical Features",
"display_name": "Extra Rights / Technical Features"
},
{
"id": 13,
"name": "User: All Documents",
"full_name": "Sales / User: All Documents",
"display_name": "Sales / User: All Documents"
},
{
"id": 12,
"name": "User: Own Documents Only",
"full_name": "Sales / User: Own Documents Only",
"display_name": "Sales / User: Own Documents Only"
}
]
}
}
GetSessionInfo
Retrieves the current session.
Request
Odoo.getSessionInfo {
onSubscribe { disposable ->
compositeDisposable.add(disposable)
}
onNext { response ->
if (response.isSuccessful) {
val getSessionInfo = response.body()!!
if (getSessionInfo.isSuccessful) {
val result = getSessionInfo.result
// ...
} else {
// Odoo specific error
Timber.w("getSessionInfo() failed with ${getSessionInfo.errorMessage}")
}
} else {
Timber.w("request failed with ${response.code()}:${response.message()}")
}
}
onError { error ->
error.printStackTrace()
}
onComplete { }
}
Result
{
"result": {
"username": "admin",
"currencies": {
"1": {
"digits": [
69,
2
],
"position": "after",
"symbol": "€"
},
"3": {
"digits": [
69,
2
],
"position": "before",
"symbol": "$"
}
},
"uid": 1,
"db": "db_v10",
"is_admin": true,
"server_version_info": [
10,
0,
0,
"final",
0,
""
],
"server_version": "10.0",
"user_context": {
"lang": "en_US",
"tz": "Europe/Brussels",
"uid": 1
},
"web.base.url": "http://192.168.43.51:8069",
"name": "Administrator",
"partner_id": 3,
"web_tours": [
],
"company_id": 1,
"session_id": "080c1e6adc00e1f2229c6312224e33c522bc6f22",
"is_superuser": true,
"user_companies": false
}
}
GetOdooUsers
List of all users in logged into the application
class SomeActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val users: List<OdooUser> = getOdooUsers()
for (user in users) {
Timber.i("user is $user")
// ...
}
}
}
GetActiveOdooUser
Current user in application.
class SomeActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val user: OdooUser? = getActiveOdooUser()
if (user != null) {
Timber.i("user is $user")
// ...
}
}
}
OdooUserByAndroidName
Returns user based on given name, if available.
class SomeActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val user: OdooUser? = odooUserByAndroidName("admin[db_v11]")
if (user != null) {
Timber.i("user is $user")
// ...
}
}
}
License
MIT License
Copyright (c) 2018 Kasim Rangwala
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.