JiwaAPI

<back to all web services

HR_StaffQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/HR_StaffRetrieves a list of staff members.
HR_StaffQuery Parameters:
NameParameterData TypeRequiredDescription
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
TitlequerystringNo
TitleStartsWithquerystringNo
TitleEndsWithquerystringNo
TitleContainsquerystringNo
TitleLikequerystringNo
TitleBetweenquerystring[]No
TitleInquerystring[]No
FNamequerystringNo
FNameStartsWithquerystringNo
FNameEndsWithquerystringNo
FNameContainsquerystringNo
FNameLikequerystringNo
FNameBetweenquerystring[]No
FNameInquerystring[]No
SNamequerystringNo
SNameStartsWithquerystringNo
SNameEndsWithquerystringNo
SNameContainsquerystringNo
SNameLikequerystringNo
SNameBetweenquerystring[]No
SNameInquerystring[]No
Position1querystringNo
Position1StartsWithquerystringNo
Position1EndsWithquerystringNo
Position1ContainsquerystringNo
Position1LikequerystringNo
Position1Betweenquerystring[]No
Position1Inquerystring[]No
Position2querystringNo
Position2StartsWithquerystringNo
Position2EndsWithquerystringNo
Position2ContainsquerystringNo
Position2LikequerystringNo
Position2Betweenquerystring[]No
Position2Inquerystring[]No
PasswordquerystringNo
PasswordStartsWithquerystringNo
PasswordEndsWithquerystringNo
PasswordContainsquerystringNo
PasswordLikequerystringNo
PasswordBetweenquerystring[]No
PasswordInquerystring[]No
IsActivequerybool?No
EmailAddressquerystringNo
EmailAddressStartsWithquerystringNo
EmailAddressEndsWithquerystringNo
EmailAddressContainsquerystringNo
EmailAddressLikequerystringNo
EmailAddressBetweenquerystring[]No
EmailAddressInquerystring[]No
EmailDisplayNamequerystringNo
EmailDisplayNameStartsWithquerystringNo
EmailDisplayNameEndsWithquerystringNo
EmailDisplayNameContainsquerystringNo
EmailDisplayNameLikequerystringNo
EmailDisplayNameBetweenquerystring[]No
EmailDisplayNameInquerystring[]No
SMTPUsernamequerystringNo
SMTPUsernameStartsWithquerystringNo
SMTPUsernameEndsWithquerystringNo
SMTPUsernameContainsquerystringNo
SMTPUsernameLikequerystringNo
SMTPUsernameBetweenquerystring[]No
SMTPUsernameInquerystring[]No
SMTPPasswordquerystringNo
SMTPPasswordStartsWithquerystringNo
SMTPPasswordEndsWithquerystringNo
SMTPPasswordContainsquerystringNo
SMTPPasswordLikequerystringNo
SMTPPasswordBetweenquerystring[]No
SMTPPasswordInquerystring[]No
UsernamequerystringNo
UsernameStartsWithquerystringNo
UsernameEndsWithquerystringNo
UsernameContainsquerystringNo
UsernameLikequerystringNo
UsernameBetweenquerystring[]No
UsernameInquerystring[]No
MustChangePasswordNextLoginquerybool?No
PasswordLastChangedDateTimequeryDateTime?No
PasswordLastChangedDateTimeGreaterThanOrEqualToqueryDateTime?No
PasswordLastChangedDateTimeGreaterThanqueryDateTime?No
PasswordLastChangedDateTimeLessThanqueryDateTime?No
PasswordLastChangedDateTimeLessThanOrEqualToqueryDateTime?No
PasswordLastChangedDateTimeNotEqualToqueryDateTime?No
PasswordLastChangedDateTimeBetweenqueryNullable<DateTime>[]No
PasswordLastChangedDateTimeInqueryNullable<DateTime>[]No
SQLLoginquerystringNo
SQLLoginStartsWithquerystringNo
SQLLoginEndsWithquerystringNo
SQLLoginContainsquerystringNo
SQLLoginLikequerystringNo
SQLLoginBetweenquerystring[]No
SQLLoginInquerystring[]No
SQLPasswordquerystringNo
SQLPasswordStartsWithquerystringNo
SQLPasswordEndsWithquerystringNo
SQLPasswordContainsquerystringNo
SQLPasswordLikequerystringNo
SQLPasswordBetweenquerystring[]No
SQLPasswordInquerystring[]No
ReportSQLLoginquerystringNo
ReportSQLLoginStartsWithquerystringNo
ReportSQLLoginEndsWithquerystringNo
ReportSQLLoginContainsquerystringNo
ReportSQLLoginLikequerystringNo
ReportSQLLoginBetweenquerystring[]No
ReportSQLLoginInquerystring[]No
ReportSQLPasswordquerystringNo
ReportSQLPasswordStartsWithquerystringNo
ReportSQLPasswordEndsWithquerystringNo
ReportSQLPasswordContainsquerystringNo
ReportSQLPasswordLikequerystringNo
ReportSQLPasswordBetweenquerystring[]No
ReportSQLPasswordInquerystring[]No
Picturequerybyte[]No
HR_Departments_RecIDquerystringNo
HR_Departments_RecIDStartsWithquerystringNo
HR_Departments_RecIDEndsWithquerystringNo
HR_Departments_RecIDContainsquerystringNo
HR_Departments_RecIDLikequerystringNo
HR_Departments_RecIDBetweenquerystring[]No
HR_Departments_RecIDInquerystring[]No
ExtensionquerystringNo
ExtensionStartsWithquerystringNo
ExtensionEndsWithquerystringNo
ExtensionContainsquerystringNo
ExtensionLikequerystringNo
ExtensionBetweenquerystring[]No
ExtensionInquerystring[]No
MobilequerystringNo
MobileStartsWithquerystringNo
MobileEndsWithquerystringNo
MobileContainsquerystringNo
MobileLikequerystringNo
MobileBetweenquerystring[]No
MobileInquerystring[]No
UsePrepaidLabourPacksquerybool?No
AuthenticationModesquerybyte?No
AuthenticationModesGreaterThanOrEqualToquerybyte?No
AuthenticationModesGreaterThanquerybyte?No
AuthenticationModesLessThanquerybyte?No
AuthenticationModesLessThanOrEqualToquerybyte?No
AuthenticationModesNotEqualToquerybyte?No
AuthenticationModesBetweenquerybyte[]No
AuthenticationModesInquerybyte[]No
WindowsDomainAccountquerystringNo
WindowsDomainAccountStartsWithquerystringNo
WindowsDomainAccountEndsWithquerystringNo
WindowsDomainAccountContainsquerystringNo
WindowsDomainAccountLikequerystringNo
WindowsDomainAccountBetweenquerystring[]No
WindowsDomainAccountInquerystring[]No
SMTPPasswordLastChangedDateTimequeryDateTime?No
SMTPPasswordLastChangedDateTimeGreaterThanOrEqualToqueryDateTime?No
SMTPPasswordLastChangedDateTimeGreaterThanqueryDateTime?No
SMTPPasswordLastChangedDateTimeLessThanqueryDateTime?No
SMTPPasswordLastChangedDateTimeLessThanOrEqualToqueryDateTime?No
SMTPPasswordLastChangedDateTimeNotEqualToqueryDateTime?No
SMTPPasswordLastChangedDateTimeBetweenqueryNullable<DateTime>[]No
SMTPPasswordLastChangedDateTimeInqueryNullable<DateTime>[]No
SY_Menu_RecIDquerystringNo
SY_Menu_RecIDStartsWithquerystringNo
SY_Menu_RecIDEndsWithquerystringNo
SY_Menu_RecIDContainsquerystringNo
SY_Menu_RecIDLikequerystringNo
SY_Menu_RecIDBetweenquerystring[]No
SY_Menu_RecIDInquerystring[]No
SY_PrintGroup_RecIDquerystringNo
SY_PrintGroup_RecIDStartsWithquerystringNo
SY_PrintGroup_RecIDEndsWithquerystringNo
SY_PrintGroup_RecIDContainsquerystringNo
SY_PrintGroup_RecIDLikequerystringNo
SY_PrintGroup_RecIDBetweenquerystring[]No
SY_PrintGroup_RecIDInquerystring[]No
SQLLoginLastSavedDateTimequeryDateTime?No
SQLLoginLastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
SQLLoginLastSavedDateTimeGreaterThanqueryDateTime?No
SQLLoginLastSavedDateTimeLessThanqueryDateTime?No
SQLLoginLastSavedDateTimeLessThanOrEqualToqueryDateTime?No
SQLLoginLastSavedDateTimeNotEqualToqueryDateTime?No
SQLLoginLastSavedDateTimeBetweenqueryDateTime[]No
SQLLoginLastSavedDateTimeInqueryDateTime[]No
ReportsLoginLastSavedDateTimequeryDateTime?No
ReportsLoginLastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
ReportsLoginLastSavedDateTimeGreaterThanqueryDateTime?No
ReportsLoginLastSavedDateTimeLessThanqueryDateTime?No
ReportsLoginLastSavedDateTimeLessThanOrEqualToqueryDateTime?No
ReportsLoginLastSavedDateTimeNotEqualToqueryDateTime?No
ReportsLoginLastSavedDateTimeBetweenqueryDateTime[]No
ReportsLoginLastSavedDateTimeInqueryDateTime[]No
IsEnabledquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
HR_Staff Parameters:
NameParameterData TypeRequiredDescription
StaffIDformstringNo
LastSavedDateTimeformDateTime?No
TitleformstringNo
FNameformstringNo
SNameformstringNo
Position1formstringNo
Position2formstringNo
PasswordformstringNo
IsActiveformbool?No
EmailAddressformstringNo
EmailDisplayNameformstringNo
SMTPUsernameformstringNo
SMTPPasswordformstringNo
UsernameformstringNo
MustChangePasswordNextLoginformbool?No
PasswordLastChangedDateTimeformDateTime?No
SQLLoginformstringNo
SQLPasswordformstringNo
ReportSQLLoginformstringNo
ReportSQLPasswordformstringNo
Pictureformbyte[]No
HR_Departments_RecIDformstringNo
ExtensionformstringNo
MobileformstringNo
UsePrepaidLabourPacksformbool?No
AuthenticationModesformbyteNo
WindowsDomainAccountformstringNo
SMTPPasswordLastChangedDateTimeformDateTime?No
SY_Menu_RecIDformstringNo
SY_PrintGroup_RecIDformstringNo
SQLLoginLastSavedDateTimeformDateTimeNo
ReportsLoginLastSavedDateTimeformDateTimeNo
IsEnabledformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/HR_Staff HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"StaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Title":"String","FName":"String","SName":"String","Position1":"String","Position2":"String","Password":"String","IsActive":false,"EmailAddress":"String","EmailDisplayName":"String","SMTPUsername":"String","SMTPPassword":"String","Username":"String","MustChangePasswordNextLogin":false,"PasswordLastChangedDateTime":"0001-01-01T00:00:00.0000000","SQLLogin":"String","SQLPassword":"String","ReportSQLLogin":"String","ReportSQLPassword":"String","Picture":"AA==","HR_Departments_RecID":"String","Extension":"String","Mobile":"String","UsePrepaidLabourPacks":false,"WindowsDomainAccount":"String","SMTPPasswordLastChangedDateTime":"0001-01-01T00:00:00.0000000","SY_Menu_RecID":"String","SY_PrintGroup_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}