Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | Guid? | No | |
RecIDIn | query | Guid[] | No | |
SY_UserGroups_RecID | query | Guid? | No | |
SY_UserGroups_RecIDIn | query | Guid[] | 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 | |
ControlType | query | string | No | |
ControlTypeStartsWith | query | string | No | |
ControlTypeEndsWith | query | string | No | |
ControlTypeContains | query | string | No | |
ControlTypeLike | query | string | No | |
ControlTypeBetween | query | string[] | No | |
ControlTypeIn | query | string[] | No | |
ControlName | query | string | No | |
ControlNameStartsWith | query | string | No | |
ControlNameEndsWith | query | string | No | |
ControlNameContains | query | string | No | |
ControlNameLike | query | string | No | |
ControlNameBetween | query | string[] | No | |
ControlNameIn | query | string[] | No | |
ReadAccessLevel | query | byte? | No | |
ReadAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
ReadAccessLevelGreaterThan | query | byte? | No | |
ReadAccessLevelLessThan | query | byte? | No | |
ReadAccessLevelLessThanOrEqualTo | query | byte? | No | |
ReadAccessLevelNotEqualTo | query | byte? | No | |
ReadAccessLevelBetween | query | byte[] | No | |
ReadAccessLevelIn | query | byte[] | No | |
WriteAccessLevel | query | byte? | No | |
WriteAccessLevelGreaterThanOrEqualTo | query | byte? | No | |
WriteAccessLevelGreaterThan | query | byte? | No | |
WriteAccessLevelLessThan | query | byte? | No | |
WriteAccessLevelLessThanOrEqualTo | query | byte? | No | |
WriteAccessLevelNotEqualTo | query | byte? | No | |
WriteAccessLevelBetween | query | byte[] | No | |
WriteAccessLevelIn | query | byte[] | 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 | |
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 | |
SY_UserGroups_RecID | form | Guid | No | |
SY_Forms_ClassName | form | string | No | |
ControlType | form | string | No | |
ControlName | form | string | No | |
ReadAccessLevel | form | byte | No | |
WriteAccessLevel | form | byte | No | |
ItemNo | form | int | 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_UserGroupPermissionsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SY_UserGroupPermissionsQuery 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>
<ControlName>String</ControlName>
<ControlNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ControlNameBetween>
<ControlNameContains>String</ControlNameContains>
<ControlNameEndsWith>String</ControlNameEndsWith>
<ControlNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ControlNameIn>
<ControlNameLike>String</ControlNameLike>
<ControlNameStartsWith>String</ControlNameStartsWith>
<ControlType>String</ControlType>
<ControlTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ControlTypeBetween>
<ControlTypeContains>String</ControlTypeContains>
<ControlTypeEndsWith>String</ControlTypeEndsWith>
<ControlTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ControlTypeIn>
<ControlTypeLike>String</ControlTypeLike>
<ControlTypeStartsWith>String</ControlTypeStartsWith>
<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>
<ReadAccessLevel>0</ReadAccessLevel>
<ReadAccessLevelBetween>AA==</ReadAccessLevelBetween>
<ReadAccessLevelGreaterThan>0</ReadAccessLevelGreaterThan>
<ReadAccessLevelGreaterThanOrEqualTo>0</ReadAccessLevelGreaterThanOrEqualTo>
<ReadAccessLevelIn>AA==</ReadAccessLevelIn>
<ReadAccessLevelLessThan>0</ReadAccessLevelLessThan>
<ReadAccessLevelLessThanOrEqualTo>0</ReadAccessLevelLessThanOrEqualTo>
<ReadAccessLevelNotEqualTo>0</ReadAccessLevelNotEqualTo>
<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>
<SY_UserGroups_RecID>00000000-0000-0000-0000-000000000000</SY_UserGroups_RecID>
<SY_UserGroups_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SY_UserGroups_RecIDIn>
<WriteAccessLevel>0</WriteAccessLevel>
<WriteAccessLevelBetween>AA==</WriteAccessLevelBetween>
<WriteAccessLevelGreaterThan>0</WriteAccessLevelGreaterThan>
<WriteAccessLevelGreaterThanOrEqualTo>0</WriteAccessLevelGreaterThanOrEqualTo>
<WriteAccessLevelIn>AA==</WriteAccessLevelIn>
<WriteAccessLevelLessThan>0</WriteAccessLevelLessThan>
<WriteAccessLevelLessThanOrEqualTo>0</WriteAccessLevelLessThanOrEqualTo>
<WriteAccessLevelNotEqualTo>0</WriteAccessLevelNotEqualTo>
</SY_UserGroupPermissionsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSY_UserGroupPermissions7kRqkrSv 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_UserGroupPermissions> <d2p1:_x003C_ControlName_x003E_k__BackingField>String</d2p1:_x003C_ControlName_x003E_k__BackingField> <d2p1:_x003C_ControlType_x003E_k__BackingField>String</d2p1:_x003C_ControlType_x003E_k__BackingField> <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField> <d2p1:_x003C_ReadAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_ReadAccessLevel_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_SY_UserGroups_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_UserGroups_RecID_x003E_k__BackingField> <d2p1:_x003C_WriteAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_WriteAccessLevel_x003E_k__BackingField> </d2p1:SY_UserGroupPermissions> </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_UserGroupPermissions7kRqkrSv>