Convention Update

Convention updates are the individual articles in the convention news system. You must have the updates ConventionPrivilege to access this. Convention Updates are accessed via /api/conventionupdate.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in ConventionUpdateProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this conventionupdate belongs to.

Services

The services used to fetch and manipulate convention updates.

Search ConventionUpdates

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/conventionupdate
Optional Params
query

Searches a partial name and the body text.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Special Guest Steve Jackson",
          ...
        },
        ...
    ]
 }

Create Convention Update

 POST /api/conventionupdate
Required Params
convention_id
name

Returns the same as a normal read.

Read Convention Update

 GET /api/conventionupdate/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Special Guest Steve Jackson",
   ...
 }

Update Convention Update

 PUT /api/conventionupdate/xxx

Returns the same as a normal read.

Delete Convention Update

 DELETE /api/conventionupdate/xxx

Returns:

 {
   "success" : 1
 }

Send Test Email

Sends a test message to the current user's account email address. This is required before sending to badge holders. This will raise an error if your convention has no defined badge types or badges.

 POST /api/conventionupdate/xxx/test

Returns the same as a normal read.

Send Update Email

Sends the update to all of the badge types selected for the update, or all badge holders if no badge types were selected. You can email an update only once. You must send a test (see above) before you can email badge holders. This will raise an error if your convention has no defined badge types or badges.

 POST /api/conventionupdate/xxx/send

Returns the same as a normal read.

Post Update

If a convention does not use badge types, you can post the update publicly without emailing. The posted update will appear publicly on the convention's Updates page. Posting an update does not restrict sending it later, if you add badge types later.

 POST /api/conventionupdate/xxx/post

Returns the same as a normal read.