This repository was archived by the owner on Oct 12, 2021. It is now read-only.
-
Couldn't load subscription status.
- Fork 11
Response
mattkol edited this page Jan 22, 2017
·
5 revisions
SugarOnRest response - SugarRestResponse class has the following properties:
| Field | Description | Comment |
|---|---|---|
| data | Formatted Pojo data returned by Unirest Java | See more info below. |
| jdata | Formatted json data returned by Unirest Java | This is same as "Data" but in json. It also has only values for selected fields if set in [Options](Request Options). |
| jsonRawRequest | Raw json request as is sent to Unirest Java | This can be useful for diagnostic purposes. |
| jsonRawResponse | Raw json response as is returned from Unirest Java | This can be useful for diagnostic purposes and alternative deserialization. |
| statusCode | Http status code returned by Unirest Java or exception returned. | Ok (200) is only valid status code. |
| error | Formatted error returned from Unirest Java or error in internal processing. | The error model is of type [ErrorResponse](Error Response). |
| Request Type | Value Type | Comment |
|---|---|---|
| ReadById | Entity data | Module entity data (e.g Accounts object). |
| BulkRead | Entity collection data | Module entity collection data (e.g List<Accounts> objects). |
| PagedRead | Entity collection data | Module entity collection data (e.g List<Accounts> objects). |
| Create | Module id | Module entity identifier in string. |
| BulkCreate | Module id collection | Module identifier collection data (e.g IList in string). |
| Update | Module id | Module entity identifier in string. |
| BulkUpdate | Module id collection | Module identifier collection data (e.g IList in string). |
| Delete | Module id | Module entity identifier in string. |
| LinkedReadById | Entity data | Module entity data (e.g CustomAccount object). |
| LinkedBulkRead | Entity collection data | Module entity collection data (e.g List<CustomAccount> objects). |
| AllModulesRead | Entity collection data | List of module names. |
SugarOnRest
- Home
- Request
- Request Types
- Request Options
- Response
- Error Response
- Read Module By Id
- Read Module Collection By Page
- Read Module Collection
- Create Module
- Create Module Collection
- Update Module
- Update Module Collection
- Delete Module
- Linked Modules 1
- Linked Modules 2
- Linked Modules 3
- Query Options 1
- Query Options 2
- Query Options 3