Cheat Sheet - Concepts Outlined in this Tutorial
Method
To help you get started with web service, here's a little memo of techniques used in this tutorial.
|
|
|
|
| Method parameters |
|
|
|
---|---|---|---|---|---|---|---|---|
| REST |
| Method |
| url | resource | id | xml |
C | POST |
| add |
| X | X |
| X |
R | GET |
| get |
| X | X | X |
|
U | UPDATE |
| edit |
| X | X | X | X |
D | DELETE |
| delete |
| X | X | X |
|
If the URL parameter is specified, no other setting can be used and vice versa.
Options
Key | Key suffix |
| prefix | Value | Suffix | Description |
---|---|---|---|---|---|---|
display |
|
|
| [field1,field2 …] |
| Only display fields in brackets |
display |
|
|
| full |
| Display all fields |
Key | Key suffix |
| prefix | Value | Suffix | Description |
---|---|---|---|---|---|---|
filter | [field] |
|
| [value1,value2] |
| Filter "field" with value between "value1" and "value2" |
filter | [field] |
|
| [value] |
| Filter field with the value "value" |
filter | [field] |
|
| [value1|value2…] |
| Filter fields for multiple values |
filter | [field] |
| % | [value] | % | Filter "columns" for values containing "value" |
Key | Key suffix |
| prefix | Value | Suffix | Description |
---|---|---|---|---|---|---|
sort |
|
|
| [field1_ASC,field2_DESC,field3_ASC] |
| Sort by field with the suffix _ASC _DESC or in the order |
sort |
|
|
| full |
| show all fields |
Key | Key suffix |
| prefix | Value | Suffix | Description |
---|---|---|---|---|---|---|
limit |
|
|
| Number |
| Limit the result to "Nunmber" |
limit |
|
|
| Starting index, Number |
| Limit the result to "Number" from the "Index" |