Get Started
Let's first learn the types in the KanonnApp
Available Types
Get # Token
To receive a token, you must apply to this address and submit username and password using the get method
https://api.kanoonapp.ir/Get/Token| Options | Value | require |
|---|---|---|
| Method | GET | Yes |
| username | kanoonapp username | Yes |
| password | kanoonapp password | Yes |
By sending this request, you will receive a response in the form of json
This response contains Account information
# Account
The most basic type is Account that contains the Kanoon information
Attributes
Typing Account has the following attributes
| Name | Data Type | Description |
|---|---|---|
| ID | Integer | Unique identifier Account |
| name | String (100) | Name of kanoon |
| user_id | Integer |
Unique identifier for creator User Main admin ID |
| date_added | Integer | Date of birthday Account in Unix time |
| data_card_expiered | Integer | Date of expiered Account in Unix time |
| hajm | Integer | Total amount of data that is available |
| hajm_used | Integer | The amount of data |
» No data can be added when the Account data volume expires
» When the account expires, if you buy a non-free product, an invoice will be activated for payment
Get Account
Get Account data method
https://api.kanoonapp.ir/Get/Account| Options | Value | require |
|---|---|---|
| Method | GET | Yes |
| Token | Unique identifier for User | Yes |
By sending this request, you will receive a response in the form of json
This response contains Account information
# User
A user is a type for admins, which can be accessed differently
Attributes
Typing user has the following attributes
| Name | Data Type | Description |
|---|---|---|
| ID | Integer | Unique identifier User |
| member_id | Integer |
Unique identifier Member of this User |
| is_admin | Integer |
1 for True ; 0 for False Main admin Permission |
| per_select | Integer |
1 for True ; 0 for False Permission for get data |
| per_insert | Integer |
1 for True ; 0 for False Permission for add data |
| per_update | Integer |
1 for True ; 0 for False Permission for update data |
| per_delete | Integer |
1 for True ; 0 for False Permission for delete data |
| String (100) | Unique email of user | |
| mobile | String (20) | Unique mobile number of user |
» Creator just can get all User Data
» Creator just can change other user data (add,update,delete)
Get User
Get Account data method
https://api.kanoonapp.ir/Get/User| Options | Value | require | defualt | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Method | GET | Yes | |||||||||||||||||||||||||||
| Token | Unique identifier for User | Yes | |||||||||||||||||||||||||||
| index | bolean | optional | True | ||||||||||||||||||||||||||
| option |
json array
|
optional | Null |
By sending this request, you will receive a response in the form of json
This response contains User information
# Member
Member is a type for humans in kanoon
Attributes
Typing member has the following attributes
| Name | Data Type | Description |
|---|---|---|
| ID | Integer | Unique identifier User |
| first_name | String (50) |
First name Member |
| last_name | String (50) |
Last name Member |
| father_name | String (50) | Father name Member |
| birthday | Integer | Date of birthday Member in Unix time |
| address | String (255) | Home adress Member |
| photo | text |
photo Member URL Base URL : https://dl.kanoonapp.ir/upload/ |
| meli_code | String (20) | Unique email of user |
| mobile1 | String (20) | Mobile number of user |
| mobile2 | String (20) | Mobile number of user |
| mobile3 | String (20) | Mobile number of user |
| home_tel | String (20) | Home number of user |
| morabi_arshad_id | Integer | Morabi 1 Member ID |
| morabi_arshad2_id | Integer | Morabi 2 Member ID |
| morabi_arshad3_id | Integer | Morabi 3 Member ID |
| edu_place_name1 | Integer | Name of study place |
| edu_maghta1 | Integer | Study Grade |
| action_id | Integer | Unique identifier Action Grade ID |
| tarbiat_id | Integer | Unique identifier Elmi Grade ID |
| tashkilat_id | Integer | Unique identifier Tashkilat Grade ID |
| mantaghe_id | Integer | Unique identifier Mantaghe ID |
| mahale_id | Integer | Unique identifier Mahale ID |
| wtn_child | Integer | What Number Child ? |
| parents1_id | Integer | Pparent 1 Member ID |
| parents2_id | Integer | Parent 2 Member ID |
| sport | String (100) | Sport Member Description |
| work | String (100) | work Member Description |
| tavanaie | String (100) | Ability Member Description |
| salary | Integer | Salary Member monthly income |
| date_added | Integer | Date of Member added in Unix time |
| is_parent | Integer |
1 for True ; 0 for False Is Member Is a Parent ? |
| bani_info | String (100) | Description If this Member donat for kanoon |
| is_bani | Integer |
1 for True ; 0 for False Is Member Is a Donater ? |
» { tarbiat_id } is Same { Elmi }
» { morabi_arshad_id } who is Member in the group
» { morabi_arshad2_id } who is Member in the Follow up
» { morabi_arshad3_id } who is Member in the List
Get Member
Get Member data method
https://api.kanoonapp.ir/Get/Member| Options | Value | require | defualt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Method | GET | Yes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Token | Unique identifier for User | Yes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| index | bolean | optional | False | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| option |
json array
|
optional | Null |