PATCH /api/transactions/:id
Update an existing Transaction

PUT /api/transactions/:id
Update an existing Transaction

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

Param name Description
transaction
required

Transaction attributes

Validations:

  • Must be a Hash
transaction[asset_id]
optional , nil allowed

ID of the corresponding Asset

Validations:

  • Must be a String
transaction[location_id]
optional

Location ID (manager only)- required even if draft if inspection (transaction) is created by managers

Validations:

  • Must be a String
transaction[department_id]
optional , nil allowed

Department ID

Validations:

  • Must be a String
transaction[work_order_id]
optional , nil allowed

Work Order ID

Validations:

  • Must be a String
transaction[task_id]
optional , nil allowed

Task ID

Validations:

  • Must be a String
transaction[check_in]
optional , nil allowed

Check-in/-out?

Validations:

  • Must be one of: true, false, 1, 0.
transaction[draft]
optional , nil allowed

Is it a draft?

Validations:

  • Must be one of: true, false, 1, 0.
transaction[damage]
optional , nil allowed

Damage?

Validations:

  • Must be one of: true, false, 1, 0.
transaction[email_recipients]
optional , nil allowed

Email addresses for transaction summary email

Validations:

  • Must be an array of String
transaction[sms_recipients]
optional , nil allowed

Phone numbers for transaction summary PDF - in format ‘+12065554321’

Validations:

  • Must be an array of String
transaction[geo_coord]
optional , nil allowed

Geographical location (longitude, latitude)

Validations:

  • Must be an array of any type
transaction[notations]
optional , nil allowed

Notations

Validations:

  • Must be a Hash
transaction[notations_extended]
optional , nil allowed

Notations extended for Inline data like media

Validations:

  • Must be a Hash
transaction[workflow_id]
optional , nil allowed

Workflow ID

Validations:

  • Must be a String
transaction[photos]
optional

Photos

Validations:

  • Must be an Array of nested elements
transaction[photos][image]
required

File ID of uploaded image

Validations:

  • Must be a String
transaction[photos][notation]
optional , nil allowed

Notation (damage type)

Validations:

  • Must be a String
transaction[photos][damage_area]
optional , nil allowed

Damage area in photo (left,top (,right,bottom)

Validations:

  • Must be point or rectangle
transaction[photos][geo_coord]
optional , nil allowed

Location (longitude, latitude)

Validations:

  • Must be an array of any type
transaction[photos][created_at]
required

Creation time

Validations:

  • Must be a String
transaction[photos][instruction_id]
optional , nil allowed

Instructions for Photo

Validations:

  • Must be a String
transaction[photos][overlays]
optional , nil allowed

Overlays the server will add to photo to indicate region of interest

Validations:

  • Must be an Array of nested elements
transaction[photos][overlays][type]
required

Type of overlay (must be ‘symbol’)

Validations:

  • Must be a String
transaction[photos][overlays][cx]
required

Left position as a float value between 0 and 1 (percentage from left)

Validations:

  • Must be a Numeric
transaction[photos][overlays][cy]
required

Top position as a float value between 0 and 1 (percentage from top)

Validations:

  • Must be a Numeric
transaction[photos][overlays][symbol]
optional , nil allowed

Symbol to overlay (must be ‘ring’, ‘ring@2x’, ‘ring@3x’)

Validations:

  • Must be a String
transaction[videos]
optional

Videos

Validations:

  • Must be an Array of nested elements
transaction[videos][video]
required

File ID of uploaded video

Validations:

  • Must be a String
transaction[videos][duration]
optional

Length of video file (in seconds)

Validations:

  • Must be a Numeric
transaction[videos][geo_coord]
optional , nil allowed

Location (longitude, latitude)

Validations:

  • Must be an array of any type
transaction[videos][created_at]
required

Creation time

Validations:

  • Must be a String
transaction[signatures]
optional

Signatures

Validations:

  • Must be an Array of nested elements
transaction[signatures][name]
optional , nil allowed

Name of the signatory

Validations:

  • Must be a String
transaction[signatures][image]
optional , nil allowed

File ID of uploaded signature image

Validations:

  • Must be a String
transaction[signatures][geo_coord]
optional , nil allowed

Location (longitude, latitude)

Validations:

  • Must be an array of any type
transaction[signatures][created_at]
required

Creation time

Validations:

  • Must be a String
transaction[files]
optional

Attached files

Validations:

  • Must be an Array of nested elements
transaction[files][file]
required

File ID of uploaded attachment

Validations:

  • Must be a String
transaction[files][description]
optional , nil allowed

Description

Validations:

  • Must be a String
transaction[ident_docs]
optional

Identification documents

Validations:

  • Must be an Array of nested elements
transaction[ident_docs][front_image]
required

File ID of uploaded image for document front

Validations:

  • Must be a String
transaction[ident_docs][back_image]
optional , nil allowed

File ID of uploaded image for document back

Validations:

  • Must be a String
transaction[ident_docs][identity]
optional

Identity information (varies by document type)

Validations:

  • Must be a Hash
transaction[forms]
optional

Form data

Validations:

  • Must be an Array of nested elements
transaction[forms][form_template_id]
required

FormTemplate ID

Validations:

  • Must be a String
transaction[forms][values]
required

Form field values

Validations:

  • Must be a Hash
transaction[extended]
optional , nil allowed

Extended data

Validations:

  • Must be a Hash
transaction[recalls]
optional , nil allowed

Vehicle recall data

Validations:

  • Must be an array of Hash