wsdlGetShiftCategories

Input Parameters

Data Name	Data Type	Comment
apiKey	String	All shift categories(shift types) from provided store will be returned
lastModified	String	Pass in empty string (””) if this parameter should be ignored. Pass in a date in format: YYYY-MM-DD hh:mm:ss to return ShiftCategories which have been modified later than than provided date. SHOULD ALWAYS BE SET..if you want to use includeTags
includeTags	boolean	If you want to include the tags connected to the shift type
includeSkills	boolean	If you want to include the skills connected to the shift type

OutPut Values

Data Name	Data Type	Format	Comment
id	Integer	-	Primary key
shiftTypeExtId	String		Shift type external Id
name	String	-	Name of the shift category
restId	Integer	-	Unit/restaurant id
begTime	Time	hh:mm:ss	00:00:00 – 23:59:59
endTime	Time	hh:mm:ss	-
breakType	Integer	0/1	0 Breaks will not show on the scheduling screen
begBreak	Time	hh:mm:ss	First break
endBreak	Time	hh:mm:ss
begBreak2	Time	hh:mm:ss	Second break
endBreak2	Time	hh:mm:ss
begBreak3	Time	hh:mm:ss	Third break
endBreak3	Time	hh:mm:ss	-
begBreak4	Time	hh:mm:ss	Fourth break
endBreak4	Time	hh:mm:ss	-
section	Integer	-	id of section. If no section is assigned then response will be = ‘1’
costCentre	Integer		Id of cost centre
salaryType	Integer	-	Id of salary type
accountNo	Integer	-	Id of account
projectNo	Integer	-	Id of project
costCentreExtCode	String	-	External Id of costCentre. Will return empty string if not set
salaryTypeExtCode	String	-	External Id of salaryType. Will return empty string if not set
accountNoExtCode	String	-	External Id of accountNo. Will return empty string if not set
projectNoExtCode	String	-	External Id of projectNo. Will return empty string if not set
onCall	Integer	0 = False, 1 = True
isActive	Boolean	true=1 false=0
isFreeDay	Boolean	true=1 false=0
countPunchHours	Boolean	true=1 false=0
countScheduleHours	Boolean	true=1 false=0
sharedToAllUnits	Boolean	true=1 false=0	Could be set to FALSE only via call wsdlUpdateShiftTypes during shift type creation/update. All shift types created from the GUI will have value TRUE by default.
scheduleCategoryUnits	scheduleCategoryUnits array		Could be set only via call wsdlUpdateShiftTypes during shift type creation/update.
tags	Tag[]
skills	skill[]
ts	Integer	-	Timestamp formatted to ISO 8601

complexType: scheduleCategoryUnits

Parameter	Data type	Format/example	Comment
unitId	Integer	If externalUnitId isnt set
externalUnitId	String	If unitId isnt set
visibleInWebpunch	boolean	true=1 false=0

Tag

Parameter	Data type	Format/example	Comment
tagCategoryName	String
tagCategoryExternalId	String
tagName	String
tagCode	String
tagExternalId	String
customFields	customField[]

skill

Parameter	Data type	Format/example	Comment
scatName	String
skillDescription	String

customField

Parameter	Data type	Format/example	Comment
label	String
value	String

Notes

Change log

Date	Released in version	Description	Author
	365	Added includeTags	Paul El Maaouchi
	369	Added includeSkills	Paul El Maaouchi
	380	Added isFreeDay, countPunchHours, countScheduleHours	Paul El Maaouchi

Result

Array

(

[0] => Array

(

[id] => 4192

[name] => Store Manager

[restId] => 818

[begTime] => 10:00:00

[endTime] => 18:00:00

[breakType] => 0

[begBreak] => 13:45:00

[endBreak] => 14:15:00

[begBreak2] => 00:00:00

[endBreak2] => 00:00:00

[begBreak3] => 00:00:00

[endBreak3] => 00:00:00

[begBreak4] => 00:00:00

[endBreak4] => 00:00:00

[section] => 601

[costCentre] => 3024

[salaryType] => 3027

[accountNo] => 3031

[projectNo] => 3042

[costCentreExtCode] => AA

[salaryTypeExtCode] => AB

[accountNoExtCode] => AC

[projectNoExtCode] => AD

[ts] => 2008-12-04T13:38:43+01:00

)

Request

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4205="uri:FlexForce">

<SOAP-ENV:Body>

<ns4205: wsdlGetShiftCategories xmlns:ns4205="uri:FlexForce">

</ns4205: wsdlGetShiftCategories>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://apiftp.quinyx.com/soap/FlexForce">

<SOAP-ENV:Body>

<ns1:wsdlGetShiftCategoriesResponse xmlns:ns1="uri:FlexForce">

<name xsi:type="xsd:string">Store Manager</name>

</item>

…