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

Entity Posting API - Staff Add/Update

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

Triggered Updates:

• The staff name for any existing transactions with the StaffId and SiteID will be updated

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 Entity:

• ID attribute: Unique identifier for staff member
  String
  (required)
• SiteID attribute: Unique identifier for site that the staff member works in
  String
  (required)
• Name: Staff Member's name
  String
  (required)
• Type: Base categorisation for Staff Member
  String
• Tags: User defined list of tags they might want to filter on
  String
• Gender: Staff Member's gender
  M/F
• DateOfBirth: Staff Member's date of birth
  yyyy-mm-dd
• Currency: The Currency value that defines the pay the staff member receives
  ISO-4217 Code e.g. USD
• StaffRates: Full history of payment rates for the staff member
  • ID attribute: Unique identifier for the rate
    String
    (required)
  • Tags: User defined list of tags they might want to filter on
    String
  • RateValue: The amount of remuneration paid for each rateterm worked
    Integer
    (required)
    • Precision attribute: The number of decimal places in the StaffRate field
      Integer
      (required)
  • RateTerm: Term by which remuneration is based
    String
    (required)
  • EffectiveFrom: DateTime when the rate comes into effect
    ISO-8601 datetime
    (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>
	<Staffs>
		<Staff id="XXX" siteId="XXX">
			<Name>XXX</Name>
			<Type>XXX</Type>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<Gender>XXX</Gender>
			<DateOfBirth>XXX</DateOfBirth>
			<Currency>XXX</Currency>
			<StaffRates>
				<StaffRate id="XXX">
					<Tags>
						<Tag>XXX</Tag>
					</Tags>
					<RateValue precision="XXX">XXX</RateValue>
					<RateTerm>XXX</RateTerm>
					<EffectiveFrom>XXX</EffectiveFrom>
				</StaffRate>
			</StaffRates>
		</Staff>
	</Staffs>
</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 member, 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="Staff">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>