addActivity

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/workflow/activity/addActivity

POST

Adds an given activities to an appointment and Job.  Adds any associated cost records. If VERSIONING is being used a new job version will be created prior to the activities being added. 

acceptable request representations:

• application/json

{ "activities": [
    {
      "code" : "ADT-234",
      "appointmentId" : "12",
      "totalQuantity" : 2, 
      "note" : "Make sure...", //not required
      "siteLocationId" : "2345" //not required 
      "activityGroupId" : "5" //not required 
    },
    {
      "code" : "BDT-234",
      "appointmentId" : "13",
      "totalQuantity" : 5
    }

  ]
}

available response representations:

• 200 - application/json

{
  "result" : "success or fail",
  "result_msg" : "error message",
  "activities" : [{activityId: "123", code: "ADT-234", "1"}
                  {activityId: "124", code: "BDT-234", "1"}
                 ]
}

See the Workflow API matrix for the full list of endpoints in this category.