JiwaAPI

<back to all web services

HR_StaffUserSettingsQuery

Requires Authentication
HR_StaffUserSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
HR_Staff_StaffIDquerystringNo
HR_Staff_StaffIDStartsWithquerystringNo
HR_Staff_StaffIDEndsWithquerystringNo
HR_Staff_StaffIDContainsquerystringNo
HR_Staff_StaffIDLikequerystringNo
HR_Staff_StaffIDBetweenquerystring[]No
HR_Staff_StaffIDInquerystring[]No
PreviewJournalquerybool?No
LastLogicalWarehouse_RecIDquerystringNo
LastLogicalWarehouse_RecIDStartsWithquerystringNo
LastLogicalWarehouse_RecIDEndsWithquerystringNo
LastLogicalWarehouse_RecIDContainsquerystringNo
LastLogicalWarehouse_RecIDLikequerystringNo
LastLogicalWarehouse_RecIDBetweenquerystring[]No
LastLogicalWarehouse_RecIDInquerystring[]No
StockTakeOrderquerybyte?No
StockTakeOrderGreaterThanOrEqualToquerybyte?No
StockTakeOrderGreaterThanquerybyte?No
StockTakeOrderLessThanquerybyte?No
StockTakeOrderLessThanOrEqualToquerybyte?No
StockTakeOrderNotEqualToquerybyte?No
StockTakeOrderBetweenquerybyte[]No
StockTakeOrderInquerybyte[]No
EnforceMinGPquerybyte?No
EnforceMinGPGreaterThanOrEqualToquerybyte?No
EnforceMinGPGreaterThanquerybyte?No
EnforceMinGPLessThanquerybyte?No
EnforceMinGPLessThanOrEqualToquerybyte?No
EnforceMinGPNotEqualToquerybyte?No
EnforceMinGPBetweenquerybyte[]No
EnforceMinGPInquerybyte[]No
SearchAutoStartqueryint?No
SearchAutoStartGreaterThanOrEqualToqueryint?No
SearchAutoStartGreaterThanqueryint?No
SearchAutoStartLessThanqueryint?No
SearchAutoStartLessThanOrEqualToqueryint?No
SearchAutoStartNotEqualToqueryint?No
SearchAutoStartBetweenqueryint[]No
SearchAutoStartInqueryint[]No
SearchReplaceTextquerybool?No
SearchFontNamequerystringNo
SearchFontNameStartsWithquerystringNo
SearchFontNameEndsWithquerystringNo
SearchFontNameContainsquerystringNo
SearchFontNameLikequerystringNo
SearchFontNameBetweenquerystring[]No
SearchFontNameInquerystring[]No
SearchFontSizequerydecimal?No
SearchFontSizeGreaterThanOrEqualToquerydecimal?No
SearchFontSizeGreaterThanquerydecimal?No
SearchFontSizeLessThanquerydecimal?No
SearchFontSizeLessThanOrEqualToquerydecimal?No
SearchFontSizeNotEqualToquerydecimal?No
SearchFontSizeBetweenquerydecimal[]No
SearchFontSizeInquerydecimal[]No
CreditorsPrintToScreenquerybool?No
IgnoreBackOrderAllocationsquerybool?No
InvoicingPrintToScreenquerybool?No
AllowModificationOfPrintedUnprocessedInvoicesquerybool?No
IncrementInvoiceNumbersquerystringNo
IncrementInvoiceNumbersStartsWithquerystringNo
IncrementInvoiceNumbersEndsWithquerystringNo
IncrementInvoiceNumbersContainsquerystringNo
IncrementInvoiceNumbersLikequerystringNo
IncrementInvoiceNumbersBetweenquerystring[]No
IncrementInvoiceNumbersInquerystring[]No
ParticipateInCustomerExperienceImprovementProgramquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
HR_StaffUserSettings Parameters:
NameParameterData TypeRequiredDescription
HR_Staff_StaffIDformstringNo
PreviewJournalformboolNo
LastLogicalWarehouse_RecIDformstringNo
StockTakeOrderformbyteNo
EnforceMinGPformbyteNo
SearchAutoStartformintNo
SearchReplaceTextformboolNo
SearchFontNameformstringNo
SearchFontSizeformdecimalNo
CreditorsPrintToScreenformboolNo
IgnoreBackOrderAllocationsformboolNo
InvoicingPrintToScreenformboolNo
AllowModificationOfPrintedUnprocessedInvoicesformboolNo
IncrementInvoiceNumbersformstringNo
ParticipateInCustomerExperienceImprovementProgramformboolNo
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.

POST /csv/reply/HR_StaffUserSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"HR_Staff_StaffID":"String","HR_Staff_StaffIDStartsWith":"String","HR_Staff_StaffIDEndsWith":"String","HR_Staff_StaffIDContains":"String","HR_Staff_StaffIDLike":"String","HR_Staff_StaffIDBetween":["String"],"HR_Staff_StaffIDIn":["String"],"PreviewJournal":false,"LastLogicalWarehouse_RecID":"String","LastLogicalWarehouse_RecIDStartsWith":"String","LastLogicalWarehouse_RecIDEndsWith":"String","LastLogicalWarehouse_RecIDContains":"String","LastLogicalWarehouse_RecIDLike":"String","LastLogicalWarehouse_RecIDBetween":["String"],"LastLogicalWarehouse_RecIDIn":["String"],"StockTakeOrder":0,"StockTakeOrderGreaterThanOrEqualTo":0,"StockTakeOrderGreaterThan":0,"StockTakeOrderLessThan":0,"StockTakeOrderLessThanOrEqualTo":0,"StockTakeOrderNotEqualTo":0,"StockTakeOrderBetween":"AA==","StockTakeOrderIn":"AA==","EnforceMinGP":0,"EnforceMinGPGreaterThanOrEqualTo":0,"EnforceMinGPGreaterThan":0,"EnforceMinGPLessThan":0,"EnforceMinGPLessThanOrEqualTo":0,"EnforceMinGPNotEqualTo":0,"EnforceMinGPBetween":"AA==","EnforceMinGPIn":"AA==","SearchAutoStart":0,"SearchAutoStartGreaterThanOrEqualTo":0,"SearchAutoStartGreaterThan":0,"SearchAutoStartLessThan":0,"SearchAutoStartLessThanOrEqualTo":0,"SearchAutoStartNotEqualTo":0,"SearchAutoStartBetween":[0],"SearchAutoStartIn":[0],"SearchReplaceText":false,"SearchFontName":"String","SearchFontNameStartsWith":"String","SearchFontNameEndsWith":"String","SearchFontNameContains":"String","SearchFontNameLike":"String","SearchFontNameBetween":["String"],"SearchFontNameIn":["String"],"SearchFontSize":0,"SearchFontSizeGreaterThanOrEqualTo":0,"SearchFontSizeGreaterThan":0,"SearchFontSizeLessThan":0,"SearchFontSizeLessThanOrEqualTo":0,"SearchFontSizeNotEqualTo":0,"SearchFontSizeBetween":[0],"SearchFontSizeIn":[0],"CreditorsPrintToScreen":false,"IgnoreBackOrderAllocations":false,"InvoicingPrintToScreen":false,"AllowModificationOfPrintedUnprocessedInvoices":false,"IncrementInvoiceNumbers":"String","IncrementInvoiceNumbersStartsWith":"String","IncrementInvoiceNumbersEndsWith":"String","IncrementInvoiceNumbersContains":"String","IncrementInvoiceNumbersLike":"String","IncrementInvoiceNumbersBetween":["String"],"IncrementInvoiceNumbersIn":["String"],"ParticipateInCustomerExperienceImprovementProgram":false,"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"HR_Staff_StaffID":"String","LastLogicalWarehouse_RecID":"String","SearchFontName":"String","IncrementInvoiceNumbers":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}