Document toolboxDocument toolbox

Fix Break Times SOAP API

Owned by Matthew Wren
Jan 29, 2024
2 min read

On This Page:

Related Pages:

The sp:FixBreakTimesRequest API method can be used to set the actual time and/or status for an employee's named break.

Description

The sp:FixBreakTimesRequest API method allows the actual time and/or status for an employee's named break.

Definition

The definition of this API is:

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:FixBreakTimesRequest>

 

 

 

 

 

<empID>?</empID>

EmpID

The identifier of the employee to whom the break is assigned.

(tick)

(tick)

 

<breaks>

 

 

(tick)

 

 

 

<BreakName>?</BreakName>

BreakName

The name of the break.

(tick)

(tick)

 

 

<BreakType>?</BreakType>

BreakType

The type of the break.

(tick)

(tick)

 

 

<BreakStart>?</BreakStart>

spDateTime

The date and time at which the Break will start/has started.

(tick)

(tick)

 

 

<BreakDuration>?</BreakDuration>

int

The length of the break in minutes. The length of the break can be 0 to 999 minutes.

(tick)

 

 

</breaks>

 

 

 

 

 <breaks> Up to 4 additional breaks structures can be supplied, if multiple named breaks are to be updated.(error) 
  If supplied, the additional breaks structure(s) match the structure above.  
 </breaks>    

 

<options>

 

Only one options structure can be supplied.

(error)

 

 

 

<Started>?</Started>

boolean

When supplied and true, all named breaks supplied will be updated to have a status of Started.

If the options value of Finished is also supplied, SP_OPTION_COMBINATION_INVALID (159) is returned.

If not supplied, and the options value of Finished is also not supplied, then any of the breaks being updated that have previously been set to have a status of either Started or Finished will be set to the Fixed state and SP_OK_BREAK_STATUS_LOST (695) is returned

(error)

 

  <Finished>?</Finished>boolean

When supplied and true, all named breaks supplied will be updated to have a status of Finished.

If the options value of Started is also supplied, SP_OPTION_COMBINATION_INVALID (159) is returned.

If not supplied, and the options value of Started is also not supplied, then any of the breaks being updated that have previously been set to have a status of either Started or Finished will be set to the Fixed state and SP_OK_BREAK_STATUS_LOST (695) is returned

(error) 

 

</options>

 

 

 

 

</sp:FixBreakTimesRequest>

 

 

 

 

The BreakStart value is local to what is specified in the tz_CJS database parameter.

This can be set such that BreakStart is local to the timezone of the responsibility unit which contains the break, local to the employee that the break is allocated to, or local to a specified or default timezone. It may also be set such that it is local to the region of a job – either the job which contains the break or, if the break is standalone, the job immediately prior to the break.

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

 Click here to expand...
  • SP_OK (0)
  • SP_DATE_INVALID (14)
  • SP_OPTIONS_INVALID (80)
  • SP_OPTION_COMBINATION_INVALID (159)
  • SP_EMPID_DOES_NOT_EXIST (231)
  • SP_BREAK_DURATION_INVALID (323)
  • SP_BREAK_EARLIEST_BEFORE_SHIFT_START (353)
  • SP_BREAK_LATEST_AFTER_SHIFT_END (354)
  • SP_OK_WITH_OVERLAPS (373)
  • SP_SO_BREAK_OUTSIDE (557)
  • SP_BREAKSEQ_DUPLICATE_BREAKNAMES (653)
  • SP_BREAKSEQ_OVERLAPS (654)
  • SP_BREAKNAME_INVALID (655)
  • SP_BREAKTYPE_NOT_FIXED (656)
  • SP_BREAKTIME_EARLIEST_INVALID (657)
  • SP_OK_BREAK_STATUS_LOST (695)