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 | |
PK | query | int? | No | |
PKGreaterThanOrEqualTo | query | int? | No | |
PKGreaterThan | query | int? | No | |
PKLessThan | query | int? | No | |
PKLessThanOrEqualTo | query | int? | No | |
PKNotEqualTo | query | int? | No | |
PKBetween | query | int[] | No | |
PKIn | query | int[] | No | |
DatabaseMajor | query | byte? | No | |
DatabaseMajorGreaterThanOrEqualTo | query | byte? | No | |
DatabaseMajorGreaterThan | query | byte? | No | |
DatabaseMajorLessThan | query | byte? | No | |
DatabaseMajorLessThanOrEqualTo | query | byte? | No | |
DatabaseMajorNotEqualTo | query | byte? | No | |
DatabaseMajorBetween | query | byte[] | No | |
DatabaseMajorIn | query | byte[] | No | |
DatabaseMinor | query | byte? | No | |
DatabaseMinorGreaterThanOrEqualTo | query | byte? | No | |
DatabaseMinorGreaterThan | query | byte? | No | |
DatabaseMinorLessThan | query | byte? | No | |
DatabaseMinorLessThanOrEqualTo | query | byte? | No | |
DatabaseMinorNotEqualTo | query | byte? | No | |
DatabaseMinorBetween | query | byte[] | No | |
DatabaseMinorIn | query | byte[] | No | |
DatabaseRelease | query | byte? | No | |
DatabaseReleaseGreaterThanOrEqualTo | query | byte? | No | |
DatabaseReleaseGreaterThan | query | byte? | No | |
DatabaseReleaseLessThan | query | byte? | No | |
DatabaseReleaseLessThanOrEqualTo | query | byte? | No | |
DatabaseReleaseNotEqualTo | query | byte? | No | |
DatabaseReleaseBetween | query | byte[] | No | |
DatabaseReleaseIn | query | byte[] | No | |
ScriptOrder | query | int? | No | |
ScriptOrderGreaterThanOrEqualTo | query | int? | No | |
ScriptOrderGreaterThan | query | int? | No | |
ScriptOrderLessThan | query | int? | No | |
ScriptOrderLessThanOrEqualTo | query | int? | No | |
ScriptOrderNotEqualTo | query | int? | No | |
ScriptOrderBetween | query | int[] | No | |
ScriptOrderIn | query | int[] | No | |
Script | query | string | No | |
ScriptStartsWith | query | string | No | |
ScriptEndsWith | query | string | No | |
ScriptContains | query | string | No | |
ScriptLike | query | string | No | |
ScriptBetween | query | string[] | No | |
ScriptIn | query | string[] | No | |
Status | query | byte? | No | |
StatusGreaterThanOrEqualTo | query | byte? | No | |
StatusGreaterThan | query | byte? | No | |
StatusLessThan | query | byte? | No | |
StatusLessThanOrEqualTo | query | byte? | No | |
StatusNotEqualTo | query | byte? | No | |
StatusBetween | query | byte[] | No | |
StatusIn | query | byte[] | No | |
Message | query | string | No | |
MessageStartsWith | query | string | No | |
MessageEndsWith | query | string | No | |
MessageContains | query | string | No | |
MessageLike | query | string | No | |
MessageBetween | query | string[] | No | |
MessageIn | query | string[] | No | |
ScriptType | query | byte? | No | |
ScriptTypeGreaterThanOrEqualTo | query | byte? | No | |
ScriptTypeGreaterThan | query | byte? | No | |
ScriptTypeLessThan | query | byte? | No | |
ScriptTypeLessThanOrEqualTo | query | byte? | No | |
ScriptTypeNotEqualTo | query | byte? | No | |
ScriptTypeBetween | query | byte[] | No | |
ScriptTypeIn | query | byte[] | No | |
RowHash | query | byte[] | 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 | |
PK | form | int | No | |
DatabaseMajor | form | byte | No | |
DatabaseMinor | form | byte | No | |
DatabaseRelease | form | byte | No | |
ScriptOrder | form | int | No | |
Script | form | string | No | |
Status | form | byte | No | |
Message | form | string | No | |
ScriptType | form | byte | No | |
RowHash | form | byte[] | 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/SY_UpgradeScriptsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SY_UpgradeScriptsQuery 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>
<DatabaseMajor>0</DatabaseMajor>
<DatabaseMajorBetween>AA==</DatabaseMajorBetween>
<DatabaseMajorGreaterThan>0</DatabaseMajorGreaterThan>
<DatabaseMajorGreaterThanOrEqualTo>0</DatabaseMajorGreaterThanOrEqualTo>
<DatabaseMajorIn>AA==</DatabaseMajorIn>
<DatabaseMajorLessThan>0</DatabaseMajorLessThan>
<DatabaseMajorLessThanOrEqualTo>0</DatabaseMajorLessThanOrEqualTo>
<DatabaseMajorNotEqualTo>0</DatabaseMajorNotEqualTo>
<DatabaseMinor>0</DatabaseMinor>
<DatabaseMinorBetween>AA==</DatabaseMinorBetween>
<DatabaseMinorGreaterThan>0</DatabaseMinorGreaterThan>
<DatabaseMinorGreaterThanOrEqualTo>0</DatabaseMinorGreaterThanOrEqualTo>
<DatabaseMinorIn>AA==</DatabaseMinorIn>
<DatabaseMinorLessThan>0</DatabaseMinorLessThan>
<DatabaseMinorLessThanOrEqualTo>0</DatabaseMinorLessThanOrEqualTo>
<DatabaseMinorNotEqualTo>0</DatabaseMinorNotEqualTo>
<DatabaseRelease>0</DatabaseRelease>
<DatabaseReleaseBetween>AA==</DatabaseReleaseBetween>
<DatabaseReleaseGreaterThan>0</DatabaseReleaseGreaterThan>
<DatabaseReleaseGreaterThanOrEqualTo>0</DatabaseReleaseGreaterThanOrEqualTo>
<DatabaseReleaseIn>AA==</DatabaseReleaseIn>
<DatabaseReleaseLessThan>0</DatabaseReleaseLessThan>
<DatabaseReleaseLessThanOrEqualTo>0</DatabaseReleaseLessThanOrEqualTo>
<DatabaseReleaseNotEqualTo>0</DatabaseReleaseNotEqualTo>
<Message>String</Message>
<MessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</MessageBetween>
<MessageContains>String</MessageContains>
<MessageEndsWith>String</MessageEndsWith>
<MessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</MessageIn>
<MessageLike>String</MessageLike>
<MessageStartsWith>String</MessageStartsWith>
<PK>0</PK>
<PKBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</PKBetween>
<PKGreaterThan>0</PKGreaterThan>
<PKGreaterThanOrEqualTo>0</PKGreaterThanOrEqualTo>
<PKIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</PKIn>
<PKLessThan>0</PKLessThan>
<PKLessThanOrEqualTo>0</PKLessThanOrEqualTo>
<PKNotEqualTo>0</PKNotEqualTo>
<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>
<RowHash>AA==</RowHash>
<Script>String</Script>
<ScriptBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ScriptBetween>
<ScriptContains>String</ScriptContains>
<ScriptEndsWith>String</ScriptEndsWith>
<ScriptIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ScriptIn>
<ScriptLike>String</ScriptLike>
<ScriptOrder>0</ScriptOrder>
<ScriptOrderBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ScriptOrderBetween>
<ScriptOrderGreaterThan>0</ScriptOrderGreaterThan>
<ScriptOrderGreaterThanOrEqualTo>0</ScriptOrderGreaterThanOrEqualTo>
<ScriptOrderIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ScriptOrderIn>
<ScriptOrderLessThan>0</ScriptOrderLessThan>
<ScriptOrderLessThanOrEqualTo>0</ScriptOrderLessThanOrEqualTo>
<ScriptOrderNotEqualTo>0</ScriptOrderNotEqualTo>
<ScriptStartsWith>String</ScriptStartsWith>
<ScriptType>0</ScriptType>
<ScriptTypeBetween>AA==</ScriptTypeBetween>
<ScriptTypeGreaterThan>0</ScriptTypeGreaterThan>
<ScriptTypeGreaterThanOrEqualTo>0</ScriptTypeGreaterThanOrEqualTo>
<ScriptTypeIn>AA==</ScriptTypeIn>
<ScriptTypeLessThan>0</ScriptTypeLessThan>
<ScriptTypeLessThanOrEqualTo>0</ScriptTypeLessThanOrEqualTo>
<ScriptTypeNotEqualTo>0</ScriptTypeNotEqualTo>
<Status>0</Status>
<StatusBetween>AA==</StatusBetween>
<StatusGreaterThan>0</StatusGreaterThan>
<StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
<StatusIn>AA==</StatusIn>
<StatusLessThan>0</StatusLessThan>
<StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
<StatusNotEqualTo>0</StatusNotEqualTo>
</SY_UpgradeScriptsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSY_UpgradeScripts7kRqkrSv 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:SY_UpgradeScripts> <d2p1:_x003C_DatabaseMajor_x003E_k__BackingField>0</d2p1:_x003C_DatabaseMajor_x003E_k__BackingField> <d2p1:_x003C_DatabaseMinor_x003E_k__BackingField>0</d2p1:_x003C_DatabaseMinor_x003E_k__BackingField> <d2p1:_x003C_DatabaseRelease_x003E_k__BackingField>0</d2p1:_x003C_DatabaseRelease_x003E_k__BackingField> <d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_x003E_k__BackingField> <d2p1:_x003C_PK_x003E_k__BackingField>0</d2p1:_x003C_PK_x003E_k__BackingField> <d2p1:_x003C_RecId_x003E_k__BackingField>String</d2p1:_x003C_RecId_x003E_k__BackingField> <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField> <d2p1:_x003C_ScriptOrder_x003E_k__BackingField>0</d2p1:_x003C_ScriptOrder_x003E_k__BackingField> <d2p1:_x003C_ScriptType_x003E_k__BackingField>0</d2p1:_x003C_ScriptType_x003E_k__BackingField> <d2p1:_x003C_Script_x003E_k__BackingField>String</d2p1:_x003C_Script_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField> </d2p1:SY_UpgradeScripts> </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> </QueryResponseOfSY_UpgradeScripts7kRqkrSv>