• Entity Posting API
• >>
• Staff Access Add/Update

Entity Posting API - Staff Access Add/Update

If the StaffAccessID does not exist, a new Staff Access record will be created. If it does, it will be updated.

Triggered Updates:

• No other data effected

Standard ShowTimeAnalytics Message Parameters:

• DataSupplierID: Assigned unique identifier for your account
  String
  (required)
• MessageSequence: Unique sequence number incremented for each message posted
  Long
  (required)
• CallbackUrl: Dataprovider defined URL that result of processing the message is posted back to
  String

Fields for Staff Access Entity:

• ID attribute: Unique identifier for StaffAccess record
  String
  (required)
• SiteID attribute: Unique identifier for site that the staff member works in
  String
  (required)
• StaffId: Unique identifier for Staff Member (link to Staff entity)
  String
  (required)
• RateId: Unique identifier for Rate by which their pay was calculated (link to Rate under Staff entity)
  String
• CheckInDateTime: Timestamp when they staff member swiped in
  ISO-8601 datetime
  (required)
• CheckOutDateTime: Timestamp when they staff member swiped out
  ISO-8601 datetime
• Currency: The Currency value that defines the amount or pay (default site's currency)
  ISO-4217 Code e.g. USD
• Cost: How much the staff member earned for this access period
  Integer
  • Precision attribute: The number of decimal places in the Cost field
    Integer
    (required)

PLEASE NOTE: All field and attribute names are case sensitive

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalytics dataSupplierId="XXX" messageSequence="XXX">
	<CallbackUrl>https://XXX</CallbackUrl>
	<StaffAccesses>
		<StaffAccess id="XXX" siteId="XXX">
			<StaffId>XXX</StaffId>
			<RateId>XXX</RateId>
			<CheckInDateTime>XXX</CheckInDateTime>
			<CheckOutDateTime>XXX</CheckOutDateTime>
			<Currency>XXX</Currency>
			<Cost precision="XXX">XXX</Cost>
		</StaffAccess>
	</StaffAccesses>
</ShowTimeAnalytics>

Callback Post Fields:

• DataSupplierID: Unique identifier for your account, same as passed in post message
• MessageSequence: Unique sequence number for message, same as passed in post message
• ID attribute: Unique identifier for Staff Access, same as passed in post message
• Status: Processing result flag - ok/error
• Error: If the status flag is "error", list of warning messages during processing

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalyticsResponse dataSupplierId="XXX" messageSequence="XXX">
    <Responses>
        <Response id="XXX" siteId="XXX" entity="StaffAccess">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>