Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
ListOfSalesOrdersToProcessStoredProcedure | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureStartsWith | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureEndsWith | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureContains | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureLike | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureBetween | query | string[] | No | |
ListOfSalesOrdersToProcessStoredProcedureIn | query | string[] | No | |
PostProcessingStoredProcedure | query | string | No | |
PostProcessingStoredProcedureStartsWith | query | string | No | |
PostProcessingStoredProcedureEndsWith | query | string | No | |
PostProcessingStoredProcedureContains | query | string | No | |
PostProcessingStoredProcedureLike | query | string | No | |
PostProcessingStoredProcedureBetween | query | string[] | No | |
PostProcessingStoredProcedureIn | query | string[] | 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 |
---|---|---|---|---|
RecID | form | string | No | |
Description | form | string | No | |
ListOfSalesOrdersToProcessStoredProcedure | form | string | No | |
PostProcessingStoredProcedure | form | string | 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/SO_BatchProcessTypesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SO_BatchProcessTypesQuery 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>
<Description>String</Description>
<DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionBetween>
<DescriptionContains>String</DescriptionContains>
<DescriptionEndsWith>String</DescriptionEndsWith>
<DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionIn>
<DescriptionLike>String</DescriptionLike>
<DescriptionStartsWith>String</DescriptionStartsWith>
<ListOfSalesOrdersToProcessStoredProcedure>String</ListOfSalesOrdersToProcessStoredProcedure>
<ListOfSalesOrdersToProcessStoredProcedureBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ListOfSalesOrdersToProcessStoredProcedureBetween>
<ListOfSalesOrdersToProcessStoredProcedureContains>String</ListOfSalesOrdersToProcessStoredProcedureContains>
<ListOfSalesOrdersToProcessStoredProcedureEndsWith>String</ListOfSalesOrdersToProcessStoredProcedureEndsWith>
<ListOfSalesOrdersToProcessStoredProcedureIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ListOfSalesOrdersToProcessStoredProcedureIn>
<ListOfSalesOrdersToProcessStoredProcedureLike>String</ListOfSalesOrdersToProcessStoredProcedureLike>
<ListOfSalesOrdersToProcessStoredProcedureStartsWith>String</ListOfSalesOrdersToProcessStoredProcedureStartsWith>
<PostProcessingStoredProcedure>String</PostProcessingStoredProcedure>
<PostProcessingStoredProcedureBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PostProcessingStoredProcedureBetween>
<PostProcessingStoredProcedureContains>String</PostProcessingStoredProcedureContains>
<PostProcessingStoredProcedureEndsWith>String</PostProcessingStoredProcedureEndsWith>
<PostProcessingStoredProcedureIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PostProcessingStoredProcedureIn>
<PostProcessingStoredProcedureLike>String</PostProcessingStoredProcedureLike>
<PostProcessingStoredProcedureStartsWith>String</PostProcessingStoredProcedureStartsWith>
<RecID>String</RecID>
<RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDBetween>
<RecIDContains>String</RecIDContains>
<RecIDEndsWith>String</RecIDEndsWith>
<RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDIn>
<RecIDLike>String</RecIDLike>
<RecIDStartsWith>String</RecIDStartsWith>
</SO_BatchProcessTypesQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSO_BatchProcessTypes7kRqkrSv 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:SO_BatchProcessTypes> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_ListOfSalesOrdersToProcessStoredProcedure_x003E_k__BackingField>String</d2p1:_x003C_ListOfSalesOrdersToProcessStoredProcedure_x003E_k__BackingField> <d2p1:_x003C_PostProcessingStoredProcedure_x003E_k__BackingField>String</d2p1:_x003C_PostProcessingStoredProcedure_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> </d2p1:SO_BatchProcessTypes> </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> </QueryResponseOfSO_BatchProcessTypes7kRqkrSv>