Transactions

Returns a list of Transactions which match the supplied filter (JSON encoded).

Currently supported filters:

• reference_number (string)
• check_in (boolean) true=check-in, false=check-out, null=add media
• damage (boolean)
• created_at (time, time range) May be a time (in ISO 8601 format), in which case only Transactions at or after that time will be returned. It may also be a range of times, expressed as an array.
• user_id (string)
• location_id (string)
• group_id (string) Group of inspections in checkout-update-checkin transaction cycle
• extended (object) Matches field(s) in the extended data. Supports dot notation to match nested objects and arrays.

Examples

    $ curl -i \
      -H "Accept: application/json; version=1" \
      -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
      "https://api.record360.com/api/transactions?after_id=41&limit=2"

    HTTP/1.1 200 OK
    Content-Type: application/json; charset=utf-8
    Cache-Control: max-age=0, private, must-revalidate

{
   "transactions":[
      {
         "id":"42",
         "external_id":"242-940-1217 x898",
         "check_in":true,
         "notations":{

         },
         "email_sent_to":[

         ],
         "damage_cost":0.0,
         "user":{
            "id":"4",
            "username":"macy@@domain.example",
            "first_name":"Macy",
            "last_name":"Metova"
         },
         "location":{
            "id":"4",
            "name":"Main Office"
         },
         "transaction":{
            "id":"8",
            "check_in":true,
            "draft":false,
            "email_sent_to":[

            ],
            "created_at":"2014-02-19T06:46:33.000Z",
            "workflow_modules":[
               "RC2",
               "LB1",
               "LB2",
               "M1",
               "N2",
               "F01",
               "E1",
               "C2"
            ],
            "archive_status":"archived",
            "workflow_id":"4099",
            "group_id":"68",
            "view_url":"https://dashboard.record360.com/dashboard/inspections/8",
            "asset":{
               "id":"42",
               "external_id":"242-940-1217 x898"
            },
            "user":{
               "id":"4",
               "username":"macy@@domain.example",
               "first_name":"Macy",
               "last_name":"Metova"
            },
            "location":{
               "id":"4",
               "name":"Main Office"
            },
            "photos":[
               {
                  "id":"15",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "url":"https://app.record360.com/m/JqS0",
                  "instruction_id":"front-fender"
               },
               {
                  "id":"16",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "url":"https://app.record360.com/m/bASE",
                  "instruction_id":"odometer"
               }
            ],
            "videos":[
               {
                  "id":"15",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "byte_size":0,
                  "url":"https://app.record360.com/m/b1Hb",
                  "duration":0.0
               },
               {
                  "id":"16",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "byte_size":0,
                  "url":"https://app.record360.com/m/68H1",
                  "duration":0.0
               }
            ],
            "signatures":[
               {
                  "id":"8",
                  "url":"https://app.record360.com/m/EBsQ",
                  "created_at":"2014-02-19T06:46:33.000Z"
               }
            ],
            "ident_docs":[

            ],
            "files":[

            ]
         },
         "drafts":[

         ],
         "photos":[

         ],
         "videos":[

         ],
         "signatures":[

         ],
         "damages":[

         ],
         "extended":{
            "fleet_id":4279
         }
      },
      {
         "id":"43",
         "external_id":"606-565-5874",
         "check_in":false,
         "notations":{

         },
         "email_sent_to":[

         ],
         "damage_cost":0.0,
         "user":{
            "id":"5",
            "username":"pleb1@@domain.example",
            "first_name":"plebian",
            "last_name":"one"
         },
         "transaction":{
            "id":"9",
            "check_in":false,
            "draft":false,
            "email_sent_to":[

            ],
            "created_at":"2014-02-19T06:46:34.000Z",
            "archive_status":"active",
            "view_url":"https://dashboard.record360.com/dashboard/inspections/9",
            "asset":{
               "id":"43",
               "external_id":"606-565-5874"
            },
            "user":{
               "id":"5",
               "username":"pleb1@@domain.example",
               "first_name":"plebian",
               "last_name":"one"
            },
            "photos":[
               {
                  "id":"17",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "url":"https://app.record360.com/m/6GSV"
               },
               {
                  "id":"18",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "url":"https://app.record360.com/m/88Se"
               }
            ],
            "videos":[
               {
                  "id":"17",
                  "created_at":"2014-02-19T06:46:33.000Z",
                  "byte_size":0,
                  "url":"https://app.record360.com/m/8EHD",
                  "duration":0.0
               },
               {
                  "id":"18",
                  "created_at":"2014-02-19T06:46:34.000Z",
                  "byte_size":0,
                  "url":"https://app.record360.com/m/77H7",
                  "duration":0.0
               }
            ],
            "signatures":[
               {
                  "id":"9",
                  "url":"https://app.record360.com/m/PWsK",
                  "created_at":"2014-02-19T06:46:34.000Z"
               }
            ],
            "ident_docs":[

            ],
            "files":[

            ]
         },
         "drafts":[

         ],
         "photos":[

         ],
         "videos":[
            {
               "id":"17",
               "duration":0.0,
               "created_at":"2014-02-19T06:46:33.000Z",
               "byte_size":0,
               "url":"https://app.record360.com/m/8EHD"
            },
            {
               "id":"18",
               "duration":0.0,
               "created_at":"2014-02-19T06:46:34.000Z",
               "byte_size":0,
               "url":"https://app.record360.com/m/77H7"
            }
         ],
         "signatures":[
            {
               "id":"9",
               "url":"https://app.record360.com/m/PWsK",
               "created_at":"2014-02-19T06:46:34.000Z"
            }
         ],
         "damages":[
            {
               "id":"17",
               "photos":[
                  {
                     "id":"17",
                     "created_at":"2014-02-19T06:46:33.000Z",
                     "byte_size":0,
                     "url":"https://app.record360.com/m/6GSV"
                  }
               ]
            },
            {
               "id":"18",
               "photos":[
                  {
                     "id":"18",
                     "created_at":"2014-02-19T06:46:33.000Z",
                     "byte_size":0,
                     "url":"https://app.record360.com/m/88Se"
                  }
               ]
            }
         ],
         "extended":{
            "fleet_id":4280
         }
      }
   ],
   "links":{
      "prev":"https://api.record360.com/api/transactions?before_id=42&limit=2",
      "next":"https://api.record360.com/api/transactions?after_id=43&limit=2"
   }
}

Params

To request a Transaction Summary PDF, access this endpoint with an Accept header of application/pdf or append .pdf to the request URL.

Supported Formats

Examples

  $ curl -i \
    -H "Accept: application/json; version=1" \
    -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
    https://api.record360.com/api/transactions/42

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  Cache-Control: max-age=0, private, must-revalidate

  {
     "transaction":{
      "id":"42",
      "check_in":false,
      "draft":false,
      "email_sent_to":[

      ],
      "created_at":"2014-02-19T21:18:33.000Z",
      "workflow_modules":[
         "RC2",
         "LB1",
         "LB2",
         "M1",
         "N2",
         "F01",
         "E1",
         "C2"
      ],
      "archive_status":"archived",
      "workflow_id":"4099",
      "group_id":"141",
      "view_url":"https://dashboard.record360.com/dashboard/inspections/42",
      "asset":{
         "id":"61",
         "external_id":"29630"
      },
      "user":{
         "id":"14",
         "username":"jpme34@@domain.example",
         "first_name":"Jo",
         "last_name":"Me"
      },
      "location":{
         "id":"4",
         "name":"Main Office"
      },
      "photos":[
         {
          "id": "1",
          "created_at": "2014-02-19T06:46:29.000Z",
          "url": ""https://app.record360.com/m/88Se",
          "byte_size": 638425,
          "geo_coord": [122.289139, 47.612417],
          "notation": "scratch",
        },
      ],
      "videos":[
        {
          "id": "1",
          "created_at": "2014-02-19T06:46:29.000Z",
          "url": "https://app.record360.com/m/8EHD",
          "thumbnail_url": "https://record360-media.s3.amazonaws.com/42/video/video1-tn.mp4",
          "byte_size": 5650782
          "geo_coord": [122.289139, 47.612417],
          "duration": 42,
        },
      ],
      "signatures":[
         {
            "id":"42",
            "url":"https://app.record360.com/m/ZRsL",
            "created_at":"2014-02-19T21:17:32.000Z"
         }
      ],
      "ident_docs":[

      ],
      "files":[
          {
            "id": "1",
            "created_at": "2014-02-19T06:46:30.000Z",
            "url": "https://record360-media.s3.amazonaws.com/42/file/ABCXYZ123.pdf",
            "byte_size": 555046
          }
      ]
   }
}

$ curl -i \
  -H "Accept: application/pdf; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  https://api.record360.com/api/transactions/42

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: inline; filename="transaction-42.pdf"
Content-Transfer-Encoding: binary
Cache-Control: max-age=0, private, must-revalidate

[PDF data]

Params

To create a Transaction with media (i.e. photos, videos, signatures, etc.):

1. Call the User Uploads endpoint, passing a unique file_id chosen by the client.
2. The response will include an upload_url. Upload the media file to that URL using a standard HTTP PUT request.
3. Reference the uploaded file by ID in the request payload, as described below.

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  -X POST \
  -H 'Content-type: application/json' \
  -d '{"transaction": { "asset_id": "43", "location_id": "44", work_order_id": "33", "department_id": "55", "group_id": "99", notations": {}, notations_extended: {}, "check_in": true, "damage": false, "geo_coord": [122.289139, 47.612417], "photos": [], "videos": [], "signatures": [{ "image": "signature1", created_at: "2016-06-14T21:33:54.000Z" }], "ident_docs": [{ "front_image": "license1", "identity": {} }] }}' \
  https://api.record360.com/api/transactions

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "transaction": {
    "id": "42",
    "check_in": true,
    "damage": false,
    "draft": false,
    "group_id": "99",
    "department_id": "55",
    "notations": { ... },
    "geo_coord": [122.289139, 47.612417],
    "email_sent_to": [],
    "sms_summary_numbers": ["+1425555555", "+1425554444"],
    "workflow_id": "12",
    "workflow_name": "Pickup",
    "archive_status": "active",
    "created_at": "2016-06-14T22:59:22.225Z",
    "asset": {
      "id": "43",
      "external_id": "0011110384607"
    },
    "user": {
      "id": "47",
      "username": "[email protected]",
      "first_name": "Some",
      "last_name": "User"
    },
    "location": {
      "id": "44",
      "name": "Main Office"
    },
    "photos": [
      {
        "id": "1",
        "created_at": "2014-02-19T06:46:29.000Z",
        "url": "https://record360-media.s3.amazonaws.com/42/image/image1.jpg",
        "byte_size": 638425,
        "geo_coord": [122.289139, 47.612417],
        "notation": "scratch",
      },
    ],
    "videos": [
      {
        "id": "1",
        "created_at": "2014-02-19T06:46:29.000Z",
        "url": "https://record360-media.s3.amazonaws.com/42/video/video1.mp4",
        "thumbnail_url": "https://record360-media.s3.amazonaws.com/42/video/video1-tn.mp4",
        "byte_size": 5650782
        "geo_coord": [122.289139, 47.612417],
        "duration": 42,
      },
    ],
    "signatures": [
      {
        "id": "1",
        "name": "J. Random Customer",
        "url": "https://record360-media.s3.amazonaws.com/42/signature/signature1.png",
        "byte_size": 13389,
        "geo_coord": [122.289139, 47.612417],
        "created_at": "2014-02-19T06:46:30.000Z"
      }
    ],
    "files": [
      {
        "id": "1",
        "created_at": "2014-02-19T06:46:30.000Z",
        "url": "https://record360-media.s3.amazonaws.com/42/file/ABCXYZ123.pdf",
        "byte_size": 555046
      }],
    "forms": [{
      form_template_id: "64",
      "values": {
        "Name": "J. Random User",
        "Street Address": "123 Main St.",
        ...
      }
    }]
  }
}

Params

You may only change a limited set of fields on an existing Transaction

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  -X PUT \
  -H 'Content-type: application/json' \
  -d '{"transaction": { "extended": { "contract_id": 78923 }}' \
  https://api.record360.com/api/transactions/42

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "transaction": {
    ...
    "extended": {
      "contract_id": 78923
    }
  }
}

Params

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  -X DELETE \
  https://api.record360.com/api/transactions/42

HTTP/1.1 204 No Content

Params

Form data will be returned as JSON or PDF, depending on the Accept header or extension (i.e. .json or .pdf)

Supported Formats

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  https://api.record360.com/api/transactions/42/forms/53

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "form": {
    "id": "53",
    "transaction_id": "42",
    "form_template": { "id": "64" },
    "created_at": "2018-04-24T21:39:43.376Z",
    "values": {
      "Name": "J. Random User",
      "Street Address": "123 Main St.",
      ...
    }
  }
}

$ curl -i \
  -H "Accept: application/pdf; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  https://api.record360.com/api/transactions/42/forms/53

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Transfer-Encoding: binary
Cache-Control: max-age=0, private, must-revalidate

[PDF Data]

Params

Examples

curl -i -H "Accept: application/json; version=1" \
-H "Content-type:application/json" \
-H "Authorization: Token eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI1NDEiLCJpYXQiOjE1MDI4NDIzMDV9.qIHEdRI9lLPfJXP-9eLY38JxtLsXdXlohREQnENKRrI" \
-X POST  \
-H 'Content-type: application/json' \
-d '{"subject": "hello api", "recipients": ["[email protected]", "[email protected]", "[email protected]"]}' \
https://api.record360.com/api/transactions/42/send_summary_email

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "recipients":["[email protected]", "[email protected]", "[email protected]"]
}

Params