POST api/ChangeEmployeeImmediate

All requests to change an Employee are considered to be new requests and must be a POST. Do not use PUT or DELETE, ImmediateUpdate/ImmplementImmediately only accepts Changes - the employee must already exist.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

None.

Body Parameters

ChangeEmployeeImmediateView

Name	Description	Type	Additional information
Change EmployeeId	The unique id assigned to this ChangeEmployee request once it is validated and saved.	integer	None.
ChangeType	Indicates the type of request being made: Use: Change to request immediate updating of an existing Employee record, ReadOnly	string	Required Matching: Change Max length: 20
ChangeStatus	Indicates the status of the current request. Leave blank when submitting a new request. ReadOnly	string	Matching: ([^'"])* Max length: 20
ReceivedDate	Set when a validated request is saved. ReadOnly	date	None.
ReceivedDate Time	Set when a validated request is saved. ReadOnly	date	None.
PickedUpDate Time	Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table. ReadOnly	date	None.
PickedUpDate	Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table. ReadOnly e	date	None.
RejectedDate Time	Set when a validated request is accepted and implemented by payroll. ReadOnly	date	None.
RejectedDate	Set when a validated request is Rejected by payroll. ReadOnly e	date	None.
ImplementedDate Time	Set when a validated request is Rejected by payroll. ReadOnly	date	None.
ImplementedDate	Set when a validated request is accepted and implemented by payroll. ReadOnly e	date	None.
EffectiveDate	Use to give an indication to payroll when this change should be applied. It is a suggestion only.	date	None.
Validation Result	Set automatically to: 0 when a request is submitted; 1 when a request is validated. ReadOnly	integer	None.
ErrorMessage	May contain errors identified when the request is processed by payroll. ReadOnly	string	Matching: ([^"])* Max length: 500
EmpCode	The unique code identifing the actual ChangeEmployee record in question. This code is required input on ALL requests. Meridian: Maximum length allowed is 8 characters. WageEasy: Maximim length allowed is 20 characters.	string	Required Matching: ([^'"])* Max length: 20
Surname	The employee's surname (last name/family name). Required when the ChangeType is Add, optional for all other ChangeTypes. Meridian: Maximum length allowed is 40 characters. WageEasy: Maximum length allowed is 50 characters.	string	Matching: ([^"])* Max length: 50
Title	The employee's salutation or title (e.g. Mr, Mrs, Sir, Doctor or Air Vice Marshall, etc). Meridian: Allowed values: Must be one of the valid Title values in the target payroll database. Maximum length allowed is 50 characters. WageEasy: Maximum length allowed is 15 characters.	string	Matching: ([^'"])* Max length: 50
Gender	The employee's sex (gender). Allowed values: Male, Female or Other Gender codes may be found using api/Lookups?type=Gender	string	Matching: ([^'"])* Max length: 6
FirstName	The employee's first name (given name/Christian name). Meridian: Maximum length allowed is 20 characters. WageEasy: Maximum length allowed is 30 characters.	string	Matching: ([^"])* Max length: 30
MiddleName	The employee's middle name Meridian: Maximum length allowed is 15 characters.	string	Matching: ([^"])* Max length: 15
PreferredName	The employee's preferred name Meridian: Maximum length allowed is 15 characters.	string	Matching: ([^"])* Max length: 15
MaritalStatus	The employee's marital status. MaritalStatus codes may be found using api/Lookups?type=MaritalStatus	string	Matching: ([^'"])* Max length: 30
Street	The street address where the ChangeEmployee lives. Meridian: Maximum length allowed is 40 characters. WageEasy: Maximum length allowed is 225 characters.	string	Matching: ([^"])* Max length: 225
SuburbCity	The suburb where the ChangeEmployee lives. Meridian: Maximum length allowed is 40 characters. WageEasy: Maximum length allowed is 40 characters.	string	Matching: ([^"])* Max length: 40
State	The state in which the ChangeEmployee lives. Meridian: Maximum length allowed is 10 characters. Allowed values: ACT, NSW, NT, WA, QLD, SA, VIC, TAS, OTH by default WageEasy: Maximum length allowed is 6 characters. State codes may be found using api/Lookups?type=State	string	Matching: ([^'"])* Max length: 10
Postcode	The postcode where the ChangeEmployee lives.	string	Matching: ([^'"])* Max length: 4
Country	The country in which the ChangeEmployee lives. Meridian: Maximum length allowed is 30 characters. WageEasy: Maximum length allowed is 40 characters. Country codes may be found using api/Lookups?type=Country	string	Matching: ([^'"])* Max length: 40
PostalStreet	The street address for the employee's postal address. Meridian: Maximum length allowed is 40 characters. WageEasy: Maximum length allowed is 225 characters.	string	Matching: ([^"])* Max length: 225
PostalSuburb City	The suburb for the employee's postal address. Meridian: Maximum length allowed is 30 characters. WageEasy: Maximum length allowed is	string	Matching: ([^"])* Max length: 40
PostalState	The state for the employee's postal address. Meridian: Maximum length allowed is 6 characters. WageEasy: Maximum length allowed is 10 characters. State codes may be found using api/Lookups?type=State	string	Matching: ([^'"])* Max length: 10
PostalPostcode	The post code for the employee's postal address.	string	Matching: ([^'"])* Max length: 4
PostalCountry	The country for the employee's postal address. Meridian: Maximum length allowed is 30 characters. WageEasy: Maximum length allowed is 40 characters. Country codes may be found using api/Lookups?type=Country	string	Matching: ([^'"])* Max length: 30
Telephone1	The employee's primary or default telephone number.	string	Matching: ([^'"])* Max length: 20
Telephone2	The employee's alternative telephone number.	string	Matching: ([^'"])* Max length: 20
HiredDate	The date the ChangeEmployee commence work.	date	None.
DefaultEmail	The employee's preferred email address. Meridian: Maximum length allowed is 100 characters. WageEasy: Maximum length allowed is 85 characters.	string	Matching: ([^'"])* Max length: 100
DefaultEmailUsed ForPayslips	Is the employee's default email to be used as the address for emailing pay advices Meridian: Allowed values:True or False WageEasy:	boolean	None.
AboriginalTorres Strait	Indicates the employee's Aborginal or Torres Strait Islander status. Allowed values:Unknown, Aboriginal, Islander, Declined, Both, Neither	string	Matching: ([^'"])* Max length: 10
Job Classification	The employee's job classification. Meridian: Allowed values:Must be one of the valid job classification values in the target payroll database. WageEasy: JobClassification codes may be found using api/Lookups?type=JobClassification	string	Matching: ([^'"])* Max length: 60
WorkersCompCode	The employee's job classification. Meridian: Allowed values:Must be one of the valid job classification values in the target payroll database. WageEasy: WorkersCompCode codes may be found using api/Lookups?type=WorkersComp	string	Matching: ([^'"])* Max length: 10
ChangeEmployee EmailView	The Employee Email View is a placeholder for a future release. This property is currently not supported, and the "DefaultEmail" property should be used instead.	Collection of ChangeEmployee EmailView	None.
PostedDate		date	None.
PostedDateTime		date	None.
UserId		integer	None.
UserName		string	None.
UserType		string	None.
PayrollDatabase		globally unique identifier	None.
DatabaseType		string	None.
SuppressedDate		date	None.
SuppressedDate Time		date	None.
ActionedDate		date	None.
ActionedDate Time		date	None.
PayrollLink Token		globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "changeEmployeeId": 1,
  "changeType": "sample string 1",
  "changeStatus": "sample string 2",
  "receivedDate": "2024-11-23T04:31:42.7300515+11:00",
  "receivedDateTime": "2024-11-23T04:31:42.7300515+11:00",
  "pickedUpDateTime": "2024-11-23T04:31:42.7300515+11:00",
  "pickedUpDate": "2024-11-23T04:31:42.7300515+11:00",
  "rejectedDateTime": "2024-11-23T04:31:42.7300515+11:00",
  "rejectedDate": "2024-11-23T04:31:42.7300515+11:00",
  "implementedDateTime": "2024-11-23T04:31:42.7300515+11:00",
  "implementedDate": "2024-11-23T04:31:42.7300515+11:00",
  "effectiveDate": "2024-11-23T04:31:42.7300515+11:00",
  "validationResult": 1,
  "errorMessage": "sample string 3",
  "empCode": "sample string 4",
  "surname": "sample string 5",
  "title": "sample string 6",
  "gender": "sample string 7",
  "firstName": "sample string 8",
  "middleName": "sample string 9",
  "preferredName": "sample string 10",
  "maritalStatus": "sample string 11",
  "street": "sample string 12",
  "suburbCity": "sample string 13",
  "state": "sample string 14",
  "postcode": "sample string 15",
  "country": "sample string 16",
  "postalStreet": "sample string 17",
  "postalSuburbCity": "sample string 18",
  "postalState": "sample string 19",
  "postalPostcode": "sample string 20",
  "postalCountry": "sample string 21",
  "telephone1": "sample string 22",
  "telephone2": "sample string 23",
  "hiredDate": "2024-11-23T04:31:42.7300515+11:00",
  "defaultEmail": "sample string 24",
  "defaultEmailUsedForPayslips": true,
  "aboriginalTorresStrait": "sample string 25",
  "jobClassification": "sample string 26",
  "workersCompCode": "sample string 27",
  "changeEmployeeEmailView": [
    {
      "changeEmployeeEmailId": 1,
      "changeEmployeeId": 1,
      "changeType": "sample string 1",
      "changeStatus": "sample string 2",
      "empCode": "sample string 3",
      "emailAddress": "sample string 4",
      "useAsDefault": true,
      "useForPayslips": true,
      "zipPassword": "sample string 5",
      "useForPaymentSummaries": true,
      "emailType": "sample string 6"
    }
  ],
  "postedDate": "2024-11-23T04:31:42.7300515+11:00",
  "postedDateTime": "2024-11-23T04:31:42.7300515+11:00",
  "userId": 1,
  "userName": "sample string 28",
  "userType": "sample string 29",
  "payrollDatabase": "936831d8-2236-4434-b187-b14a6e442e6f",
  "databaseType": "sample string 31",
  "suppressedDate": "2024-11-23T04:31:42.7457034+11:00",
  "suppressedDateTime": "2024-11-23T04:31:42.7457034+11:00",
  "actionedDate": "2024-11-23T04:31:42.7457034+11:00",
  "actionedDateTime": "2024-11-23T04:31:42.7457034+11:00",
  "payrollLinkToken": "b19c58b7-e407-4b96-b5ee-82f1dcec31e9"
}

application/xml, text/xml

Sample:

<ChangeEmployeeImmediateView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChangeEmployeeId>1</ChangeEmployeeId>
  <ChangeType>sample string 1</ChangeType>
  <ChangeStatus>sample string 2</ChangeStatus>
  <ReceivedDate>2024-11-23T04:31:42.7300515+11:00</ReceivedDate>
  <ReceivedDateTime>2024-11-23T04:31:42.7300515+11:00</ReceivedDateTime>
  <PickedUpDateTime>2024-11-23T04:31:42.7300515+11:00</PickedUpDateTime>
  <PickedUpDate>2024-11-23T04:31:42.7300515+11:00</PickedUpDate>
  <RejectedDateTime>2024-11-23T04:31:42.7300515+11:00</RejectedDateTime>
  <RejectedDate>2024-11-23T04:31:42.7300515+11:00</RejectedDate>
  <ImplementedDateTime>2024-11-23T04:31:42.7300515+11:00</ImplementedDateTime>
  <ImplementedDate>2024-11-23T04:31:42.7300515+11:00</ImplementedDate>
  <EffectiveDate>2024-11-23T04:31:42.7300515+11:00</EffectiveDate>
  <ValidationResult>1</ValidationResult>
  <ErrorMessage>sample string 3</ErrorMessage>
  <EmpCode>sample string 4</EmpCode>
  <Surname>sample string 5</Surname>
  <Title>sample string 6</Title>
  <Gender>sample string 7</Gender>
  <FirstName>sample string 8</FirstName>
  <MiddleName>sample string 9</MiddleName>
  <PreferredName>sample string 10</PreferredName>
  <MaritalStatus>sample string 11</MaritalStatus>
  <Street>sample string 12</Street>
  <SuburbCity>sample string 13</SuburbCity>
  <State>sample string 14</State>
  <Postcode>sample string 15</Postcode>
  <Country>sample string 16</Country>
  <PostalStreet>sample string 17</PostalStreet>
  <PostalSuburbCity>sample string 18</PostalSuburbCity>
  <PostalState>sample string 19</PostalState>
  <PostalPostcode>sample string 20</PostalPostcode>
  <PostalCountry>sample string 21</PostalCountry>
  <Telephone1>sample string 22</Telephone1>
  <Telephone2>sample string 23</Telephone2>
  <HiredDate>2024-11-23T04:31:42.7300515+11:00</HiredDate>
  <DefaultEmail>sample string 24</DefaultEmail>
  <DefaultEmailUsedForPayslips>true</DefaultEmailUsedForPayslips>
  <AboriginalTorresStrait>sample string 25</AboriginalTorresStrait>
  <JobClassification>sample string 26</JobClassification>
  <WorkersCompCode>sample string 27</WorkersCompCode>
  <ChangeEmployeeEmailView>
    <ChangeEmployeeEmailView>
      <ChangeEmployeeEmailId>1</ChangeEmployeeEmailId>
      <ChangeEmployeeId>1</ChangeEmployeeId>
      <ChangeType>sample string 1</ChangeType>
      <ChangeStatus>sample string 2</ChangeStatus>
      <EmpCode>sample string 3</EmpCode>
      <EmailAddress>sample string 4</EmailAddress>
      <UseAsDefault>true</UseAsDefault>
      <UseForPayslips>true</UseForPayslips>
      <ZIPPassword>sample string 5</ZIPPassword>
      <UseForPaymentSummaries>true</UseForPaymentSummaries>
      <EmailType>sample string 6</EmailType>
    </ChangeEmployeeEmailView>
  </ChangeEmployeeEmailView>
  <PostedDate>2024-11-23T04:31:42.7300515+11:00</PostedDate>
  <PostedDateTime>2024-11-23T04:31:42.7300515+11:00</PostedDateTime>
  <UserId>1</UserId>
  <UserName>sample string 28</UserName>
  <UserType>sample string 29</UserType>
  <PayrollDatabase>936831d8-2236-4434-b187-b14a6e442e6f</PayrollDatabase>
  <DatabaseType>sample string 31</DatabaseType>
  <SuppressedDate>2024-11-23T04:31:42.7457034+11:00</SuppressedDate>
  <SuppressedDateTime>2024-11-23T04:31:42.7457034+11:00</SuppressedDateTime>
  <ActionedDate>2024-11-23T04:31:42.7457034+11:00</ActionedDate>
  <ActionedDateTime>2024-11-23T04:31:42.7457034+11:00</ActionedDateTime>
  <PayrollLinkToken>b19c58b7-e407-4b96-b5ee-82f1dcec31e9</PayrollLinkToken>
</ChangeEmployeeImmediateView>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The unique identifier assigned to the new request (ChangeEmployeeId : int)

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of HttpResponse Headers	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatus Code	boolean	None.