Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | Guid? | No | |
RecIDIn | query | Guid[] | 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 | |
SY_Forms_ClassName | query | string | No | |
SY_Forms_ClassNameStartsWith | query | string | No | |
SY_Forms_ClassNameEndsWith | query | string | No | |
SY_Forms_ClassNameContains | query | string | No | |
SY_Forms_ClassNameLike | query | string | No | |
SY_Forms_ClassNameBetween | query | string[] | No | |
SY_Forms_ClassNameIn | query | string[] | No | |
HostTabControlName | query | string | No | |
HostTabControlNameStartsWith | query | string | No | |
HostTabControlNameEndsWith | query | string | No | |
HostTabControlNameContains | query | string | No | |
HostTabControlNameLike | query | string | No | |
HostTabControlNameBetween | query | string[] | No | |
HostTabControlNameIn | query | string[] | No | |
TabKey | query | string | No | |
TabKeyStartsWith | query | string | No | |
TabKeyEndsWith | query | string | No | |
TabKeyContains | query | string | No | |
TabKeyLike | query | string | No | |
TabKeyBetween | query | string[] | No | |
TabKeyIn | query | string[] | No | |
TabCaption | query | string | No | |
TabCaptionStartsWith | query | string | No | |
TabCaptionEndsWith | query | string | No | |
TabCaptionContains | query | string | No | |
TabCaptionLike | query | string | No | |
TabCaptionBetween | query | string[] | No | |
TabCaptionIn | query | string[] | No | |
StoredProcedureName | query | string | No | |
StoredProcedureNameStartsWith | query | string | No | |
StoredProcedureNameEndsWith | query | string | No | |
StoredProcedureNameContains | query | string | No | |
StoredProcedureNameLike | query | string | No | |
StoredProcedureNameBetween | query | string[] | No | |
StoredProcedureNameIn | query | string[] | No | |
IsEnabled | query | bool? | 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 | Guid | No | |
Description | form | string | No | |
SY_Forms_ClassName | form | string | No | |
HostTabControlName | form | string | No | |
TabKey | form | string | No | |
TabCaption | form | string | No | |
StoredProcedureName | form | string | No | |
IsEnabled | form | bool | 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_Custom_MaintenanceForm_TabsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SY_Custom_MaintenanceForm_TabsQuery 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>
<HostTabControlName>String</HostTabControlName>
<HostTabControlNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</HostTabControlNameBetween>
<HostTabControlNameContains>String</HostTabControlNameContains>
<HostTabControlNameEndsWith>String</HostTabControlNameEndsWith>
<HostTabControlNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</HostTabControlNameIn>
<HostTabControlNameLike>String</HostTabControlNameLike>
<HostTabControlNameStartsWith>String</HostTabControlNameStartsWith>
<IsEnabled>false</IsEnabled>
<RecID>00000000-0000-0000-0000-000000000000</RecID>
<RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</RecIDIn>
<RowHash>AA==</RowHash>
<SY_Forms_ClassName>String</SY_Forms_ClassName>
<SY_Forms_ClassNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_Forms_ClassNameBetween>
<SY_Forms_ClassNameContains>String</SY_Forms_ClassNameContains>
<SY_Forms_ClassNameEndsWith>String</SY_Forms_ClassNameEndsWith>
<SY_Forms_ClassNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SY_Forms_ClassNameIn>
<SY_Forms_ClassNameLike>String</SY_Forms_ClassNameLike>
<SY_Forms_ClassNameStartsWith>String</SY_Forms_ClassNameStartsWith>
<StoredProcedureName>String</StoredProcedureName>
<StoredProcedureNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</StoredProcedureNameBetween>
<StoredProcedureNameContains>String</StoredProcedureNameContains>
<StoredProcedureNameEndsWith>String</StoredProcedureNameEndsWith>
<StoredProcedureNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</StoredProcedureNameIn>
<StoredProcedureNameLike>String</StoredProcedureNameLike>
<StoredProcedureNameStartsWith>String</StoredProcedureNameStartsWith>
<TabCaption>String</TabCaption>
<TabCaptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TabCaptionBetween>
<TabCaptionContains>String</TabCaptionContains>
<TabCaptionEndsWith>String</TabCaptionEndsWith>
<TabCaptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TabCaptionIn>
<TabCaptionLike>String</TabCaptionLike>
<TabCaptionStartsWith>String</TabCaptionStartsWith>
<TabKey>String</TabKey>
<TabKeyBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TabKeyBetween>
<TabKeyContains>String</TabKeyContains>
<TabKeyEndsWith>String</TabKeyEndsWith>
<TabKeyIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TabKeyIn>
<TabKeyLike>String</TabKeyLike>
<TabKeyStartsWith>String</TabKeyStartsWith>
</SY_Custom_MaintenanceForm_TabsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSY_Custom_MaintenanceForm_Tabs7kRqkrSv 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_Custom_MaintenanceForm_Tabs> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_HostTabControlName_x003E_k__BackingField>String</d2p1:_x003C_HostTabControlName_x003E_k__BackingField> <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField> <d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>String</d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField> <d2p1:_x003C_StoredProcedureName_x003E_k__BackingField>String</d2p1:_x003C_StoredProcedureName_x003E_k__BackingField> <d2p1:_x003C_TabCaption_x003E_k__BackingField>String</d2p1:_x003C_TabCaption_x003E_k__BackingField> <d2p1:_x003C_TabKey_x003E_k__BackingField>String</d2p1:_x003C_TabKey_x003E_k__BackingField> </d2p1:SY_Custom_MaintenanceForm_Tabs> </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_Custom_MaintenanceForm_Tabs7kRqkrSv>