REST Web Service Help
Overview
This is the Page/Calendar web service.
Access is granted based on username and password parameters. You should use a POST request. Please contact your sales representative to locate these values.
Format user=[user name] and pass=[password] - After a successful login, you will receive a token in the response. You should use this token in the query string instead of the username/password arguments: &token=[token]
Parameters
Parameters allow you to filter the query. Simply append one or more of the desired parameters below to your URL - /services/rest/pdf?token=xxx¶meter=xxx.
All queries are limited to a maximum of 100 results. For access to more than 100, use the start filter with multiple iterative calls.
| Parameter | Description |
|---|---|
| fields | Specify which data elements to return. Format: &fields=[comma separated list of fields] |
| format | The format in which you wish to view the results. Format: &format=['json' or 'xml'] |
| start | Offset at which to start results, e.g. skip the first N results. Format: &start=N |
| limit | Limit results to a total of N. Format: &limit=N |
| date_sort | The sort order of date property. Default: descending. Format: text (desc, asc) |
Fields
Fields are segments of data returned by each service. Below is a list of the fields you will receive in this service. If you want to receive a subset of fields, you may append &fields=[one or more fields separated by a comma] to your URL - /services/rest/pdf?token=xxx&fields=field1,field2.
| Field | Description |
|---|---|
| nid | The unique identifier of the content. Format: integer. |
| created | The date the content was initally created. Format: UNIX timestamp. |
| changed | The most recent modification date. Format: UNIX timestamp. |
| action | Whether this is a new or updated story. Format: string. |
| title | The page title. Format: text. |
| url | The page URL. Format: text. |
| field_pdf_file | PDF File. Format: filefield |