Skip to content

Area Status Management

Endpoints Used

  1. GET /areas/{area_id}
    1. Get the Area information.
  2. GET /{area_id}/civil_status
    1. Get the Civil Statuses for the Area.
  3. GET /areas/{area_id}/history?q=&page=1&count=10
    1. Add any Area history or notes.
  4. GET /areas/{area_id}/gate-status
    1. Get the gate statuses for an Area.
  5. GET /area-tasks?Area={area_id}&gate={gate_id}&q=&page=1&count=10
    1. Get any area tasks for a gate.
  6. GET /files?namespace=areas/{area_id}&page=1&count=10
    1. Any documentation attached to the Area.
  7. GET /area-type-transitions?task={task_id}&type={area_type_id}&q=&page=1&count=10
    1. The area tasks template for an Area Type and task Id.
  8. PUT /Area-tasks/{id} {"area_task":{"area_id":"{area_id}","assignee_id":"search_the_customer_id_on_email","gate_transition_assignee_id": null,"task_id":{task_id},"forecast_date":"2024-03-01T07:45:13.000Z","status":"task_statuses_above","comments":"{comment}"}}
    1. Add all the information required on the Area Task
  9. POST /areas/{area_Id}/civil_status Payload: {"task_id":{task_id}}}
    1. Update the Area to transition to this task. It will update the Area Status attached to the tasks gate.

Prerequisites to move an Area through the Area status flow

  1. You know the Area you are going to work with see API Specification.
  2. Understand the concept of gates and tasks.

Get The Required Area Information

Goal

Get all the information pertaining to the Area's civil statuses.

Steps to Follow

  1. Get the Area you are looking for with the calls in the API Specification.
    1. GET /areas/{area_id}
  2. After you have the Area information get the civil status for the Area.
    1. GET /{area_id}/civil_status
    2. This will return a list of the current gate information as well as tasks associated to the gate.
  3. If required get the Area History.
    1. GET /areas/{area_id}/history?q=&page=1&count=10
  4. Get the overall gate statuses for the Area.
    1. GET /areas/{area_id}/gate-status
  5. Get all Area tasks for that gate id.
    1. GET /Area-tasks?Area={area_id}&gate={gate_id}&q=&page=1&count=10
  6. Get any documentation attached to the Area.
    1. GET /files?namespace=areas/{area_id}&page=1&count=10

Move an Area from one gate to another

Goal

Moving the Area through the civil status process.

Steps to Follow

  1. After following the steps above get the task information required.
    1. GET /Area-type-transitions?task={task_id}&type={area_type_id}&q=&page=1&count=10
  2. Get the customer information from the agent email in the API Specification.
  3. The following is a list of all the statuses for a task currently no API available "Not Started", "In Progress", "Skipped", "Complete", "On Hold".
  4. Update all the information required for the task.
    1. PUT /Area-tasks/{id} {"area_task":{"area_id":"{area_id}","assignee_id":"search_the_customer_id_on_email","gate_transition_assignee_id": null,"task_id":{task_id},"forecast_date":"2024-03-01T07:45:13.000Z","status":"task_statuses_above","comments":"{comment}"}}
  5. If required do a Post to the Area History if there is any comments.
    1. POST /areas/{area_id}/history Payload: {"area_history":{"area_id":"CF5B78C9-F09E-4F43-81BA-292B37F703A5","notes":"{notes}"}}
  6. Update the Area to the task id that is completed.
    1. POST /areas/{area_Id}/civil_status Payload: {"task_id":{task_id}}}
Automation Exchange