Skip to content

Jobs and Steps

Steps within a job define the workflow of the job.

Completing the first step starts the job, and completing all steps completes the job. Steps must be completed in order, so that no steps are skipped.

Steps may optionally include an address. Steps will be automatically inherited from the template, you only need to supply step information if you are supplying a street address that is not saved in the template.

If you are sending a step address, ensure that you send a display name as well as the lat and long of the location, the format is as follows:

   <steps type="array">
        <step>
            <name>Step Name Here</name>
             <location>
                <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>
                <lat>-36.865387</lat>
                <lng>174.780437</lng>
            </location>
        </step>
    </steps>

In the example above, the street address is supplied for a named step. If you prefer, you can also define the step that needs the address from the step order. The following example supplies an address for the 2nd step on the job:

    <steps type="array">
        <step>
            <order>2</order>
            <location>
                <formatted_address>Auckland Hospital Park Road, Grafton, Auckland, New Zealand</formatted_address>
                <lat>-36.859552</lat>
                <lng>174.770386</lng>
            </location>
        </step>
    </steps>