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 | |
SY_Menu_RecID | query | string | No | |
SY_Menu_RecIDStartsWith | query | string | No | |
SY_Menu_RecIDEndsWith | query | string | No | |
SY_Menu_RecIDContains | query | string | No | |
SY_Menu_RecIDLike | query | string | No | |
SY_Menu_RecIDBetween | query | string[] | No | |
SY_Menu_RecIDIn | query | string[] | No | |
Type | query | byte? | No | |
TypeGreaterThanOrEqualTo | query | byte? | No | |
TypeGreaterThan | query | byte? | No | |
TypeLessThan | query | byte? | No | |
TypeLessThanOrEqualTo | query | byte? | No | |
TypeNotEqualTo | query | byte? | No | |
TypeBetween | query | byte[] | No | |
TypeIn | query | byte[] | No | |
Caption | query | string | No | |
CaptionStartsWith | query | string | No | |
CaptionEndsWith | query | string | No | |
CaptionContains | query | string | No | |
CaptionLike | query | string | No | |
CaptionBetween | query | string[] | No | |
CaptionIn | query | string[] | No | |
SY_MenuItem_RecID | query | string | No | |
SY_MenuItem_RecIDStartsWith | query | string | No | |
SY_MenuItem_RecIDEndsWith | query | string | No | |
SY_MenuItem_RecIDContains | query | string | No | |
SY_MenuItem_RecIDLike | query | string | No | |
SY_MenuItem_RecIDBetween | query | string[] | No | |
SY_MenuItem_RecIDIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
RowHash | query | byte[] | No | |
SY_Image_RecID | query | Guid? | No | |
SY_Image_RecIDIn | query | Nullable<Guid>[] | No | |
SY_Image_RecID_Selected | query | Guid? | No | |
SY_Image_RecID_SelectedIn | query | Nullable<Guid>[] | No | |
SY_Image_RecID_HotTracked | query | Guid? | No | |
SY_Image_RecID_HotTrackedIn | query | Nullable<Guid>[] | 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 | |
SY_Menu_RecID | form | string | No | |
Type | form | byte | No | |
Caption | form | string | No | |
SY_MenuItem_RecID | form | string | No | |
ItemNo | form | int | No | |
LastSavedDateTime | form | DateTime | No | |
RowHash | form | byte[] | No | |
SY_Image_RecID | form | Guid? | No | |
SY_Image_RecID_Selected | form | Guid? | No | |
SY_Image_RecID_HotTracked | form | Guid? | 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_MenuItemQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SY_MenuItemQuery 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>
<Caption>String</Caption>
<CaptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CaptionBetween>
<CaptionContains>String</CaptionContains>
<CaptionEndsWith>String</CaptionEndsWith>
<CaptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CaptionIn>
<CaptionLike>String</CaptionLike>
<CaptionStartsWith>String</CaptionStartsWith>
<ItemNo>0</ItemNo>
<ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ItemNoBetween>
<ItemNoGreaterThan>0</ItemNoGreaterThan>
<ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
<ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ItemNoIn>
<ItemNoLessThan>0</ItemNoLessThan>
<ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
<ItemNoNotEqualTo>0</ItemNoNotEqualTo>
<LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
<LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeBetween>
<LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
<LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
<LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeIn>
<LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
<LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
<LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
<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>
<SY_Image_RecID>00000000-0000-0000-0000-000000000000</SY_Image_RecID>
<SY_Image_RecIDIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SY_Image_RecIDIn>
<SY_Image_RecID_HotTracked>00000000-0000-0000-0000-000000000000</SY_Image_RecID_HotTracked>
<SY_Image_RecID_HotTrackedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SY_Image_RecID_HotTrackedIn>
<SY_Image_RecID_Selected>00000000-0000-0000-0000-000000000000</SY_Image_RecID_Selected>
<SY_Image_RecID_SelectedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SY_Image_RecID_SelectedIn>
<SY_MenuItem_RecID>String</SY_MenuItem_RecID>
<SY_MenuItem_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_MenuItem_RecIDBetween>
<SY_MenuItem_RecIDContains>String</SY_MenuItem_RecIDContains>
<SY_MenuItem_RecIDEndsWith>String</SY_MenuItem_RecIDEndsWith>
<SY_MenuItem_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_MenuItem_RecIDIn>
<SY_MenuItem_RecIDLike>String</SY_MenuItem_RecIDLike>
<SY_MenuItem_RecIDStartsWith>String</SY_MenuItem_RecIDStartsWith>
<SY_Menu_RecID>String</SY_Menu_RecID>
<SY_Menu_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_Menu_RecIDBetween>
<SY_Menu_RecIDContains>String</SY_Menu_RecIDContains>
<SY_Menu_RecIDEndsWith>String</SY_Menu_RecIDEndsWith>
<SY_Menu_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_Menu_RecIDIn>
<SY_Menu_RecIDLike>String</SY_Menu_RecIDLike>
<SY_Menu_RecIDStartsWith>String</SY_Menu_RecIDStartsWith>
<Type>0</Type>
<TypeBetween>AA==</TypeBetween>
<TypeGreaterThan>0</TypeGreaterThan>
<TypeGreaterThanOrEqualTo>0</TypeGreaterThanOrEqualTo>
<TypeIn>AA==</TypeIn>
<TypeLessThan>0</TypeLessThan>
<TypeLessThanOrEqualTo>0</TypeLessThanOrEqualTo>
<TypeNotEqualTo>0</TypeNotEqualTo>
</SY_MenuItemQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSY_MenuItem7kRqkrSv 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_MenuItem> <d2p1:_x003C_Caption_x003E_k__BackingField>String</d2p1:_x003C_Caption_x003E_k__BackingField> <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_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_SY_Image_RecID_HotTracked_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_Image_RecID_HotTracked_x003E_k__BackingField> <d2p1:_x003C_SY_Image_RecID_Selected_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_Image_RecID_Selected_x003E_k__BackingField> <d2p1:_x003C_SY_Image_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_Image_RecID_x003E_k__BackingField> <d2p1:_x003C_SY_MenuItem_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_MenuItem_RecID_x003E_k__BackingField> <d2p1:_x003C_SY_Menu_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_Menu_RecID_x003E_k__BackingField> <d2p1:_x003C_Type_x003E_k__BackingField>0</d2p1:_x003C_Type_x003E_k__BackingField> </d2p1:SY_MenuItem> </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_MenuItem7kRqkrSv>