Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HR_Staff_StaffID | query | string | No | |
HR_Staff_StaffIDStartsWith | query | string | No | |
HR_Staff_StaffIDEndsWith | query | string | No | |
HR_Staff_StaffIDContains | query | string | No | |
HR_Staff_StaffIDLike | query | string | No | |
HR_Staff_StaffIDBetween | query | string[] | No | |
HR_Staff_StaffIDIn | query | string[] | No | |
PreviewJournal | query | bool? | No | |
LastLogicalWarehouse_RecID | query | string | No | |
LastLogicalWarehouse_RecIDStartsWith | query | string | No | |
LastLogicalWarehouse_RecIDEndsWith | query | string | No | |
LastLogicalWarehouse_RecIDContains | query | string | No | |
LastLogicalWarehouse_RecIDLike | query | string | No | |
LastLogicalWarehouse_RecIDBetween | query | string[] | No | |
LastLogicalWarehouse_RecIDIn | query | string[] | No | |
StockTakeOrder | query | byte? | No | |
StockTakeOrderGreaterThanOrEqualTo | query | byte? | No | |
StockTakeOrderGreaterThan | query | byte? | No | |
StockTakeOrderLessThan | query | byte? | No | |
StockTakeOrderLessThanOrEqualTo | query | byte? | No | |
StockTakeOrderNotEqualTo | query | byte? | No | |
StockTakeOrderBetween | query | byte[] | No | |
StockTakeOrderIn | query | byte[] | No | |
EnforceMinGP | query | byte? | No | |
EnforceMinGPGreaterThanOrEqualTo | query | byte? | No | |
EnforceMinGPGreaterThan | query | byte? | No | |
EnforceMinGPLessThan | query | byte? | No | |
EnforceMinGPLessThanOrEqualTo | query | byte? | No | |
EnforceMinGPNotEqualTo | query | byte? | No | |
EnforceMinGPBetween | query | byte[] | No | |
EnforceMinGPIn | query | byte[] | No | |
SearchAutoStart | query | int? | No | |
SearchAutoStartGreaterThanOrEqualTo | query | int? | No | |
SearchAutoStartGreaterThan | query | int? | No | |
SearchAutoStartLessThan | query | int? | No | |
SearchAutoStartLessThanOrEqualTo | query | int? | No | |
SearchAutoStartNotEqualTo | query | int? | No | |
SearchAutoStartBetween | query | int[] | No | |
SearchAutoStartIn | query | int[] | No | |
SearchReplaceText | query | bool? | No | |
SearchFontName | query | string | No | |
SearchFontNameStartsWith | query | string | No | |
SearchFontNameEndsWith | query | string | No | |
SearchFontNameContains | query | string | No | |
SearchFontNameLike | query | string | No | |
SearchFontNameBetween | query | string[] | No | |
SearchFontNameIn | query | string[] | No | |
SearchFontSize | query | decimal? | No | |
SearchFontSizeGreaterThanOrEqualTo | query | decimal? | No | |
SearchFontSizeGreaterThan | query | decimal? | No | |
SearchFontSizeLessThan | query | decimal? | No | |
SearchFontSizeLessThanOrEqualTo | query | decimal? | No | |
SearchFontSizeNotEqualTo | query | decimal? | No | |
SearchFontSizeBetween | query | decimal[] | No | |
SearchFontSizeIn | query | decimal[] | No | |
CreditorsPrintToScreen | query | bool? | No | |
IgnoreBackOrderAllocations | query | bool? | No | |
InvoicingPrintToScreen | query | bool? | No | |
AllowModificationOfPrintedUnprocessedInvoices | query | bool? | No | |
IncrementInvoiceNumbers | query | string | No | |
IncrementInvoiceNumbersStartsWith | query | string | No | |
IncrementInvoiceNumbersEndsWith | query | string | No | |
IncrementInvoiceNumbersContains | query | string | No | |
IncrementInvoiceNumbersLike | query | string | No | |
IncrementInvoiceNumbersBetween | query | string[] | No | |
IncrementInvoiceNumbersIn | query | string[] | No | |
ParticipateInCustomerExperienceImprovementProgram | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HR_Staff_StaffID | form | string | No | |
PreviewJournal | form | bool | No | |
LastLogicalWarehouse_RecID | form | string | No | |
StockTakeOrder | form | byte | No | |
EnforceMinGP | form | byte | No | |
SearchAutoStart | form | int | No | |
SearchReplaceText | form | bool | No | |
SearchFontName | form | string | No | |
SearchFontSize | form | decimal | No | |
CreditorsPrintToScreen | form | bool | No | |
IgnoreBackOrderAllocations | form | bool | No | |
InvoicingPrintToScreen | form | bool | No | |
AllowModificationOfPrintedUnprocessedInvoices | form | bool | No | |
IncrementInvoiceNumbers | form | string | No | |
ParticipateInCustomerExperienceImprovementProgram | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/HR_StaffUserSettingsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<HR_StaffUserSettingsQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<AllowModificationOfPrintedUnprocessedInvoices>false</AllowModificationOfPrintedUnprocessedInvoices>
<CreditorsPrintToScreen>false</CreditorsPrintToScreen>
<EnforceMinGP>0</EnforceMinGP>
<EnforceMinGPBetween>AA==</EnforceMinGPBetween>
<EnforceMinGPGreaterThan>0</EnforceMinGPGreaterThan>
<EnforceMinGPGreaterThanOrEqualTo>0</EnforceMinGPGreaterThanOrEqualTo>
<EnforceMinGPIn>AA==</EnforceMinGPIn>
<EnforceMinGPLessThan>0</EnforceMinGPLessThan>
<EnforceMinGPLessThanOrEqualTo>0</EnforceMinGPLessThanOrEqualTo>
<EnforceMinGPNotEqualTo>0</EnforceMinGPNotEqualTo>
<HR_Staff_StaffID>String</HR_Staff_StaffID>
<HR_Staff_StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</HR_Staff_StaffIDBetween>
<HR_Staff_StaffIDContains>String</HR_Staff_StaffIDContains>
<HR_Staff_StaffIDEndsWith>String</HR_Staff_StaffIDEndsWith>
<HR_Staff_StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</HR_Staff_StaffIDIn>
<HR_Staff_StaffIDLike>String</HR_Staff_StaffIDLike>
<HR_Staff_StaffIDStartsWith>String</HR_Staff_StaffIDStartsWith>
<IgnoreBackOrderAllocations>false</IgnoreBackOrderAllocations>
<IncrementInvoiceNumbers>String</IncrementInvoiceNumbers>
<IncrementInvoiceNumbersBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IncrementInvoiceNumbersBetween>
<IncrementInvoiceNumbersContains>String</IncrementInvoiceNumbersContains>
<IncrementInvoiceNumbersEndsWith>String</IncrementInvoiceNumbersEndsWith>
<IncrementInvoiceNumbersIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</IncrementInvoiceNumbersIn>
<IncrementInvoiceNumbersLike>String</IncrementInvoiceNumbersLike>
<IncrementInvoiceNumbersStartsWith>String</IncrementInvoiceNumbersStartsWith>
<InvoicingPrintToScreen>false</InvoicingPrintToScreen>
<LastLogicalWarehouse_RecID>String</LastLogicalWarehouse_RecID>
<LastLogicalWarehouse_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastLogicalWarehouse_RecIDBetween>
<LastLogicalWarehouse_RecIDContains>String</LastLogicalWarehouse_RecIDContains>
<LastLogicalWarehouse_RecIDEndsWith>String</LastLogicalWarehouse_RecIDEndsWith>
<LastLogicalWarehouse_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastLogicalWarehouse_RecIDIn>
<LastLogicalWarehouse_RecIDLike>String</LastLogicalWarehouse_RecIDLike>
<LastLogicalWarehouse_RecIDStartsWith>String</LastLogicalWarehouse_RecIDStartsWith>
<ParticipateInCustomerExperienceImprovementProgram>false</ParticipateInCustomerExperienceImprovementProgram>
<PreviewJournal>false</PreviewJournal>
<SearchAutoStart>0</SearchAutoStart>
<SearchAutoStartBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</SearchAutoStartBetween>
<SearchAutoStartGreaterThan>0</SearchAutoStartGreaterThan>
<SearchAutoStartGreaterThanOrEqualTo>0</SearchAutoStartGreaterThanOrEqualTo>
<SearchAutoStartIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</SearchAutoStartIn>
<SearchAutoStartLessThan>0</SearchAutoStartLessThan>
<SearchAutoStartLessThanOrEqualTo>0</SearchAutoStartLessThanOrEqualTo>
<SearchAutoStartNotEqualTo>0</SearchAutoStartNotEqualTo>
<SearchFontName>String</SearchFontName>
<SearchFontNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SearchFontNameBetween>
<SearchFontNameContains>String</SearchFontNameContains>
<SearchFontNameEndsWith>String</SearchFontNameEndsWith>
<SearchFontNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SearchFontNameIn>
<SearchFontNameLike>String</SearchFontNameLike>
<SearchFontNameStartsWith>String</SearchFontNameStartsWith>
<SearchFontSize>0</SearchFontSize>
<SearchFontSizeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>0</d2p1:decimal>
</SearchFontSizeBetween>
<SearchFontSizeGreaterThan>0</SearchFontSizeGreaterThan>
<SearchFontSizeGreaterThanOrEqualTo>0</SearchFontSizeGreaterThanOrEqualTo>
<SearchFontSizeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>0</d2p1:decimal>
</SearchFontSizeIn>
<SearchFontSizeLessThan>0</SearchFontSizeLessThan>
<SearchFontSizeLessThanOrEqualTo>0</SearchFontSizeLessThanOrEqualTo>
<SearchFontSizeNotEqualTo>0</SearchFontSizeNotEqualTo>
<SearchReplaceText>false</SearchReplaceText>
<StockTakeOrder>0</StockTakeOrder>
<StockTakeOrderBetween>AA==</StockTakeOrderBetween>
<StockTakeOrderGreaterThan>0</StockTakeOrderGreaterThan>
<StockTakeOrderGreaterThanOrEqualTo>0</StockTakeOrderGreaterThanOrEqualTo>
<StockTakeOrderIn>AA==</StockTakeOrderIn>
<StockTakeOrderLessThan>0</StockTakeOrderLessThan>
<StockTakeOrderLessThanOrEqualTo>0</StockTakeOrderLessThanOrEqualTo>
<StockTakeOrderNotEqualTo>0</StockTakeOrderNotEqualTo>
</HR_StaffUserSettingsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfHR_StaffUserSettings7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:HR_StaffUserSettings> <d2p1:_x003C_AllowModificationOfPrintedUnprocessedInvoices_x003E_k__BackingField>false</d2p1:_x003C_AllowModificationOfPrintedUnprocessedInvoices_x003E_k__BackingField> <d2p1:_x003C_CreditorsPrintToScreen_x003E_k__BackingField>false</d2p1:_x003C_CreditorsPrintToScreen_x003E_k__BackingField> <d2p1:_x003C_EnforceMinGP_x003E_k__BackingField>0</d2p1:_x003C_EnforceMinGP_x003E_k__BackingField> <d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField>String</d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField> <d2p1:_x003C_IgnoreBackOrderAllocations_x003E_k__BackingField>false</d2p1:_x003C_IgnoreBackOrderAllocations_x003E_k__BackingField> <d2p1:_x003C_IncrementInvoiceNumbers_x003E_k__BackingField>String</d2p1:_x003C_IncrementInvoiceNumbers_x003E_k__BackingField> <d2p1:_x003C_InvoicingPrintToScreen_x003E_k__BackingField>false</d2p1:_x003C_InvoicingPrintToScreen_x003E_k__BackingField> <d2p1:_x003C_LastLogicalWarehouse_RecID_x003E_k__BackingField>String</d2p1:_x003C_LastLogicalWarehouse_RecID_x003E_k__BackingField> <d2p1:_x003C_ParticipateInCustomerExperienceImprovementProgram_x003E_k__BackingField>false</d2p1:_x003C_ParticipateInCustomerExperienceImprovementProgram_x003E_k__BackingField> <d2p1:_x003C_PreviewJournal_x003E_k__BackingField>false</d2p1:_x003C_PreviewJournal_x003E_k__BackingField> <d2p1:_x003C_SearchAutoStart_x003E_k__BackingField>0</d2p1:_x003C_SearchAutoStart_x003E_k__BackingField> <d2p1:_x003C_SearchFontName_x003E_k__BackingField>String</d2p1:_x003C_SearchFontName_x003E_k__BackingField> <d2p1:_x003C_SearchFontSize_x003E_k__BackingField>0</d2p1:_x003C_SearchFontSize_x003E_k__BackingField> <d2p1:_x003C_SearchReplaceText_x003E_k__BackingField>false</d2p1:_x003C_SearchReplaceText_x003E_k__BackingField> <d2p1:_x003C_StockTakeOrder_x003E_k__BackingField>0</d2p1:_x003C_StockTakeOrder_x003E_k__BackingField> </d2p1:HR_StaffUserSettings> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfHR_StaffUserSettings7kRqkrSv>