First of all

• If you got some error, make sure the bellow points:
  • URL
  • usr
  • pwd
  • Cookie
  • parameter
  • DocType
  • Doc
  • Permissions
  • HTTP response Code

1. Auth

• This is mandatory before any sequence of requests (except Auth).
• After pass the auth, you should get and save the cookie.
• You should send it with your API call, and it should be valid.

URL

• http(or https)://(URL)/api/method/login

Method

• POST

Parameters

• usr
  • mandatory
  • Login name of your WELA.
• pwd
  • mandatory
  • Password for usr .

Return

• SUCCESS
  • JSON (with message property)
• FAIL
  • HTTP Status Code 40x

2. Search

URL

• http(or https)://(WELA)/api/resource/(DocType name)

Method

• GET

Parameters

• limit_start
  • optional
  • default: 0
  • Offset for pagination
• limit_page_length
  • optional
  • default: 20
  • Limit for pagination
• conditions
  • optional
  • Conditions for search
  • e.g. "name= foobar@example.com "
• fields
  • optional
  • Keys and values in the DocType.
  • e.g. "name=first_name"

Return

• SUCCESS
  • JSON
• FAIL
  • HTTP Status Code 40x

3. Get

URL

• http(or https)://(WELA)/api/resource/(DocType name)/(Doc name)

Method

• GET

Parameters

• (none)

Return

• SUCCESS
  • JSON
• FAIL
  • HTTP Status Code 40x

4. Insert

URL

• http(or https)://(WELA)/api/resource/(DocType name)

Method

• POST

Parameters

• JSON

Return

• SUCCESS
  • JSON
• FAIL:
  • HTTP Status Code 40x

5. Update

URL

• http(or https)://(WELA)/api/resource/(DocType name)/(Doc Name)

Method

• PUT

Parameters

• JSON

Return

• SUCCESS
  • JSON
• FAIL:
  • HTTP Status Code 40x

6. Delete

URL

• http(or https)://(WELA)/api/resource/(DocType name)/(Doc Name)

Method

• DELETE

Parameters

• (none)

Return

• SUCCESS
  • JSON
• FAIL:
  • HTTP Status Code 40x