GetJobs
This call is to retrieve an array of Job objects for the location.
Response Parameters
-
AllowAddItem
bool— True if employees under this Job are allowed to add items, False if not -
AlternateId
string— Alternate external Id for this Job -
CannotClose
bool— True if employees under this Job are allowed to close, False if not -
CanOpenAnyOrder
bool— True if employees under this Job are allowed to open any order, False if not -
CashDrawer
bool— True if employees under this Job are allowed to be assigned a cash drawer, False if not -
CheckoutRequiresApproval
bool— True if employees under this Job require approval for their checkout, False if not -
ClockInRequiresApproval
bool— True if employees under this Job require approval for their clockin, False if not -
ClockOutRequiresApproval
bool— True if employees under this Job require approval for their clockout, False if not -
DeclareTips
bool— True if employees under this Job can declare tips, False if not -
DefaultScreenId
int?— Id of this Job's default screen -
DefaultSecurityLevelId
int?— Id of this Job's default security level -
DefaultSecurityLevelUniqueId
Guid?— Primary Key for Default SecurityLevel -
DisplayColor
int— ARGB encoded color for this Job's display -
ExcludeOnSalesAndLaborReports
bool— True if employees under this Job are excluded on sales and labor reports, False if not -
ExemptFromLaborSchedule
bool— True if employees under this Job are exempt from the labor schedule, False if not -
ExportCode
string— Export code for this Job -
GroupItemsBySeat
bool— True if employees under this Job can group items by seat, False if not -
Id
int— Unique Id in PAR POS for this Job -
IndicateTrainingModeOnKitchenChits
bool— Indicator on kitchen chits for orders created by staff in training mode -
IsBartender
bool— True if this Job is a bartender Job, False if not -
IsDeliveryDispatcher
bool— True if this Job is a delivery dispatcher Job, False if not -
IsDeliveryDriver
bool— True if this Job is a delivery driver Job, False if not -
IsHostess
bool— True if this Job is a hostess Job, False if not -
ItemLookup
bool— True if employees under this Job can perform an item lookup, False if not -
JobUniqueId
Guid— Primary Key for Job -
LaneId
int?— Lane Id assigned to this Job -
LimitedDestinationId
int?— Maps to the Id of the Destination this Job is limited to, if applicable -
LimitShiftBreakTypes
bool— True if employees under this Job have limited shift break types, False if not -
LocationType
byte— Returns one of the following:- 0 = Quick Service
- 1 = Table Service
-
Menus
Array of JobMenu— Menus for this JobJobMenu Properties
- Days
byte?— Days of the week this Menu is active for this Job (binary-encoded: 1=Sun, 2=Mon, 4=Tue, 8=Wed, 16=Thu, 32=Fri, 64=Sat) - MenuId
int— Maps to the Id of the Menu assigned to this Job - StartTime
TimeSpan?— Time of day this Menu becomes active for this Job
- Days
-
Name
string— Name of this Job -
NoCashTransactions
bool— True if employees under this Job are not allowed to perform cash transactions, False if not -
OrderEntry
bool— True if employees under this Job are allowed to enter orders, False if not -
OrderScreenId
int?— Id of the order screen for this Job -
RequireTipReporting
bool— True if employees under this Job can present a minimum required tip declaration at the end of the shift, False if not -
SectionId
int?— Maps to the Id of the Section for this Job -
SelfBanking
bool— True if employees under this Job can be self-banking, False if not -
SelfVoid
bool— True if employees under this Job can self-void, False if not -
ShiftBreakTypes
Array of JobShiftBreakType— Job shift break types allowed for this JobJobShiftBreakType Properties
- Id
int— Unique Id of the Job-ShiftBreakType relationship - ShiftBreakTypeId
int— Maps to the Id of the ShiftBreakType allowed for this Job
- Id
-
Tabs
bool— True if employees under this Job can open tabs, False if not -
Training
bool— True if this Job is a training Job, False if not
- Type: stringS
O A P Action required
SOAP envelope for GetJobs request. No parameters required.
- text/xml; charset=utf-8
curl --request POST \
--url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetJobs' \
--header 'Content-Type: text/xml; charset=utf-8' \
--header 'AccessToken: your-access-token' \
--header 'LocationToken: your-location-token' \
--header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetJobs"' \
--data '<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:GetJobs/>
</soapenv:Body>
</soapenv:Envelope>'
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<Settings2_GetJobsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
<Settings2_GetJobsResult>
<Message>Success</Message>
<ResultCode>0</ResultCode>
<Jobs>
<Job>
<AllowAddItem>true</AllowAddItem>
<AlternateId>SRV</AlternateId>
<CannotClose>false</CannotClose>
<CanOpenAnyOrder>true</CanOpenAnyOrder>
<CashDrawer>true</CashDrawer>
<CheckoutRequiresApproval>false</CheckoutRequiresApproval>
<ClockInRequiresApproval>false</ClockInRequiresApproval>
<ClockOutRequiresApproval>false</ClockOutRequiresApproval>
<DeclareTips>true</DeclareTips>
<DefaultScreenId>0</DefaultScreenId>
<DefaultSecurityLevelId>1</DefaultSecurityLevelId>
<DefaultSecurityLevelUniqueId>e5f6a7b8-c9d0-1234-ef01-234567890123</DefaultSecurityLevelUniqueId>
<DisplayColor>16711680</DisplayColor>
<ExcludeOnSalesAndLaborReports>false</ExcludeOnSalesAndLaborReports>
<ExemptFromLaborSchedule>false</ExemptFromLaborSchedule>
<ExportCode>SRV</ExportCode>
<GroupItemsBySeat>false</GroupItemsBySeat>
<Id>1</Id>
<IsBartender>false</IsBartender>
<IsDeliveryDispatcher>false</IsDeliveryDispatcher>
<IsDeliveryDriver>false</IsDeliveryDriver>
<IsHostess>false</IsHostess>
<ItemLookup>true</ItemLookup>
<JobUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</JobUniqueId>
<LaneId>0</LaneId>
<LimitedDestinationId>0</LimitedDestinationId>
<LimitShiftBreakTypes>false</LimitShiftBreakTypes>
<LocationType>0</LocationType>
<Menus>
<JobMenu>
<Days>127</Days>
<MenuId>1</MenuId>
<StartTime>PT0S</StartTime>
</JobMenu>
</Menus>
<Name>Server</Name>
<NoCashTransactions>false</NoCashTransactions>
<OrderEntry>true</OrderEntry>
<OrderScreenId>0</OrderScreenId>
<RequireTipReporting>false</RequireTipReporting>
<SectionId>0</SectionId>
<SelfBanking>false</SelfBanking>
<SelfVoid>false</SelfVoid>
<ShiftBreakTypes>
<JobShiftBreakType>
<ShiftBreakTypeId>1</ShiftBreakTypeId>
</JobShiftBreakType>
</ShiftBreakTypes>
<Tabs>true</Tabs>
<Training>false</Training>
<IndicateTrainingModeOnKitchenChits>false</IndicateTrainingModeOnKitchenChits>
</Job>
</Jobs>
</Settings2_GetJobsResult>
</Settings2_GetJobsResponse>
</s:Body>
</s:Envelope>