Skip to main content

Form 11 Shortcodes

Information

When issuing a Form 11, there are a number of shortcodes that can be placed in the template to auto-fill values relating to the violation.

The base short code is formatted like:

  • [values show=violation._____]

The blank value must be filled with a value to pull from the violation info.

For each nested value in the data packet, the packet name must be added as part of the variable name, each part separated by a period, with the variable to be output by the shortcode as the final part of the variable.

The packet itself is called by 'violation', and the name must be placed at the start of any value call.

Violation Packet

The violation info packet is formatted like this example.

The values on the left are the variable names, the values on the right are the example values returned by this packet.

{
    "ViolationID": 237,
    "SemPermitID": null,
    "Ticket": "TT-19026",
    "VehicleID": 5,
    "Spoiled": 0,
    "TicketType": 1,
    "Issued": "2024-07-17 16:11:00",
    "convNotice": null,
    "Due": "2024-07-27 16:11:00",
    "ViolationTypeID": -1,
    "Fine": "50.0000",
    "AdjustedFine": "20.0000",
    "Towing": "0.0000",
    "taxAmount": "0.0000",
    "Writer": 7,
    "LocationID": 10,
    "Comment": null,
    "TicketAppeal": null,
    "appealType": 0,
    "appealFormat": null,
    "AccessAdminID": 50,
    "ActionedPer": null,
    "Created": "2024-07-17 20:12:08",
    "AppealUserID": 0,
    "AppealProcessDate": null,
    "AppealAdminID": 0,
    "AppealComment": null,
    "AppealAdminComment": null,
    "AutoNotice": 0,
    "ProcessedByCollection": null,
    "SentToCollections": null,
    "PrivateComments": "",
    "DriveAway": 0,
    "UUID": null,
    "VioNotice": null,
    "latitude": null,
    "longitude": null,
    "Warning": null,
    "userid": null,
    "incidentID": null,
    "failToIdentify": null,
    "pin": "YL",
    "duplicate": null,
    "AdjustmentReason": null,
    "notices_count": 1,
  
    "user_info": {
            "UserID": 5,
            "studentNo": null,
            "employNo": "00800147",
            "account_number": null,
            "username": "mashbury",
            "UserTypeID": 7,
            "firstName": "Michael",
            "preferredname": null,
            "lastName": "Ashbury",
            "street": "688 Zaproxy Ridge",
            "city": "East Romaineburgh",
            "prov": 9,
            "postal": "K2G5B1",
            "email": "mash-bury@tomahawk.ca",
            "display_name": "Michael Ashbury",
            "account_no": "00800147",
            "prov_name": "Ontario",
    },
  
    "writer": {
            "AdminAccessID": 7,
            "Username": "admin",
            "DisplayName": "Administrator"
    },
  
    "vehicle": {
            "VehicleID": 5,
            "Active": 1,
            "lastUpdate": "2016-02-02T02:39:39.000000Z",
            "Plate": "MASH",
            "PlateTypeID": 8,
            "ProvID": 62,
            "MakeID": 24,
            "TypeID": 9,
            "ColourID": 8,
            "Year": 1998,
            "TotalVio": 12,
            "TotalUnpaid": 2,
            "TotalWarning": 0,
            "created": "2016-02-02T02:39:39.000000Z",
            "externallookupdate": null,
            "externallookupRequestID": null,
            "modified": "2024-07-18T00:12:08.000000Z",
            "vehicleAlert": true,
            "vin": "JNAMA43H9XGE50339",
            "electric_vehicle": false,
          
            "province": {
                    "ProvID": 62,
                    "ProvName": "West Virginia",
                    "Country": 2,
                    "ProvCode": "WV",
                    "modified": "2022-08-30T21:55:44.000000Z",
                    "payments": 1
            }
    },
  
    "location": {
            "LocationID": 10,
            "LocationName": "Hospital & Administration Building",
            "WriterVisible": 1,
            "GisNo": 0,
            "modified": "2019-08-23T17:13:13.000000Z"
    },
  
    "details": {
            "ViolationsDetailID": 359,
            "ViolationID": 237,
            "Ticket": "TT-19026",
            "ViolationTypeID": 16,
            "LocationID": 10,
            "offenceFine": 50,
            "discountFlag": 1,
            "discountAmount": 20,
            "discountHours": 240,
            "created": "2024-07-18T00:12:08.000000Z",
          
            "type": {
                    "ViolationTypeID": 16,
                    "ViolationDescr": "No Parking Snow Route - Mandatory Towing",
                    "DefaultCost": 50,
                    "created": "2016-09-07T17:08:24.000000Z",
                    "discountFlag": true,
                    "discountAmount": 20,
                    "discountHours": 240,
                    "adminOnly": false,
                    "violationkey": null,
                    "modified": "2020-10-07T18:51:12.000000Z",
                    "category_id": 1,
                    "adjustable": false,
                    "bylawcode": null
            }
    }
}

Examples

An example shortcode is provided for each section. To return a specific value in the same section, replace the provided variable name with the sibling value wanted for output.

Example Shortcode
 Description

[values show=violation.Ticket]

 Returns the violation ticket number.
[values show=violation.user_info.username] Returns the username of the user the violation belongs to.
[values show=violation.writer.DisplayName] Returns the display name of the admin who assigned the violation to the user.
[values show=violation.vehicle.Plate] Returns the plate of the vehicle the violation was assigned to, if applicable.
[values show=violation.vehicle.province.ProvName] Returns the province or state of the vehicle plate.
[values show=violation.location.LocationName] Returns the name of the location the infraction happened.
[values show=violation.details.0.Ticket] Returns the violation ticket number. Alternate value location.
[values show=violation.details.0.type.ViolationDescr] Returns the violation type description.
Back to top