JiwaAPI

SY_UserGroupsQuery

**SY_UserGroupsQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	Guid?	No
RecIDIn	query	Guid[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	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
RowHash	query	byte[]	No
IsDefault	query	bool?	No
IsEnabled	query	bool?	No
IsReadOnly	query	bool?	No
DefaultReadAccessLevel	query	byte?	No
DefaultReadAccessLevelGreaterThanOrEqualTo	query	byte?	No
DefaultReadAccessLevelGreaterThan	query	byte?	No
DefaultReadAccessLevelLessThan	query	byte?	No
DefaultReadAccessLevelLessThanOrEqualTo	query	byte?	No
DefaultReadAccessLevelNotEqualTo	query	byte?	No
DefaultReadAccessLevelBetween	query	byte[]	No
DefaultReadAccessLevelIn	query	byte[]	No
DefaultWriteAccessLevel	query	byte?	No
DefaultWriteAccessLevelGreaterThanOrEqualTo	query	byte?	No
DefaultWriteAccessLevelGreaterThan	query	byte?	No
DefaultWriteAccessLevelLessThan	query	byte?	No
DefaultWriteAccessLevelLessThanOrEqualTo	query	byte?	No
DefaultWriteAccessLevelNotEqualTo	query	byte?	No
DefaultWriteAccessLevelBetween	query	byte[]	No
DefaultWriteAccessLevelIn	query	byte[]	No
DefaultAbstractAccessLevel	query	byte?	No
DefaultAbstractAccessLevelGreaterThanOrEqualTo	query	byte?	No
DefaultAbstractAccessLevelGreaterThan	query	byte?	No
DefaultAbstractAccessLevelLessThan	query	byte?	No
DefaultAbstractAccessLevelLessThanOrEqualTo	query	byte?	No
DefaultAbstractAccessLevelNotEqualTo	query	byte?	No
DefaultAbstractAccessLevelBetween	query	byte[]	No
DefaultAbstractAccessLevelIn	query	byte[]	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
DefaultRESTAPIAccessLevel	query	byte?	No
DefaultRESTAPIAccessLevelGreaterThanOrEqualTo	query	byte?	No
DefaultRESTAPIAccessLevelGreaterThan	query	byte?	No
DefaultRESTAPIAccessLevelLessThan	query	byte?	No
DefaultRESTAPIAccessLevelLessThanOrEqualTo	query	byte?	No
DefaultRESTAPIAccessLevelNotEqualTo	query	byte?	No
DefaultRESTAPIAccessLevelBetween	query	byte[]	No
DefaultRESTAPIAccessLevelIn	query	byte[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**SY_UserGroups** Parameters:
Name	Parameter	Data Type	Required
RecID	form	Guid	No
Name	form	string	No
Description	form	string	No
RowHash	form	byte[]	No
IsDefault	form	bool	No
IsEnabled	form	bool	No
IsReadOnly	form	bool	No
DefaultReadAccessLevel	form	byte	No
DefaultWriteAccessLevel	form	byte	No
DefaultAbstractAccessLevel	form	byte	No
SY_Menu_RecID	form	string	No
DefaultRESTAPIAccessLevel	form	byte	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SY_UserGroupsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_UserGroupsQuery 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>
  <DefaultAbstractAccessLevel>0</DefaultAbstractAccessLevel>
  <DefaultAbstractAccessLevelBetween>AA==</DefaultAbstractAccessLevelBetween>
  <DefaultAbstractAccessLevelGreaterThan>0</DefaultAbstractAccessLevelGreaterThan>
  <DefaultAbstractAccessLevelGreaterThanOrEqualTo>0</DefaultAbstractAccessLevelGreaterThanOrEqualTo>
  <DefaultAbstractAccessLevelIn>AA==</DefaultAbstractAccessLevelIn>
  <DefaultAbstractAccessLevelLessThan>0</DefaultAbstractAccessLevelLessThan>
  <DefaultAbstractAccessLevelLessThanOrEqualTo>0</DefaultAbstractAccessLevelLessThanOrEqualTo>
  <DefaultAbstractAccessLevelNotEqualTo>0</DefaultAbstractAccessLevelNotEqualTo>
  <DefaultRESTAPIAccessLevel>0</DefaultRESTAPIAccessLevel>
  <DefaultRESTAPIAccessLevelBetween>AA==</DefaultRESTAPIAccessLevelBetween>
  <DefaultRESTAPIAccessLevelGreaterThan>0</DefaultRESTAPIAccessLevelGreaterThan>
  <DefaultRESTAPIAccessLevelGreaterThanOrEqualTo>0</DefaultRESTAPIAccessLevelGreaterThanOrEqualTo>
  <DefaultRESTAPIAccessLevelIn>AA==</DefaultRESTAPIAccessLevelIn>
  <DefaultRESTAPIAccessLevelLessThan>0</DefaultRESTAPIAccessLevelLessThan>
  <DefaultRESTAPIAccessLevelLessThanOrEqualTo>0</DefaultRESTAPIAccessLevelLessThanOrEqualTo>
  <DefaultRESTAPIAccessLevelNotEqualTo>0</DefaultRESTAPIAccessLevelNotEqualTo>
  <DefaultReadAccessLevel>0</DefaultReadAccessLevel>
  <DefaultReadAccessLevelBetween>AA==</DefaultReadAccessLevelBetween>
  <DefaultReadAccessLevelGreaterThan>0</DefaultReadAccessLevelGreaterThan>
  <DefaultReadAccessLevelGreaterThanOrEqualTo>0</DefaultReadAccessLevelGreaterThanOrEqualTo>
  <DefaultReadAccessLevelIn>AA==</DefaultReadAccessLevelIn>
  <DefaultReadAccessLevelLessThan>0</DefaultReadAccessLevelLessThan>
  <DefaultReadAccessLevelLessThanOrEqualTo>0</DefaultReadAccessLevelLessThanOrEqualTo>
  <DefaultReadAccessLevelNotEqualTo>0</DefaultReadAccessLevelNotEqualTo>
  <DefaultWriteAccessLevel>0</DefaultWriteAccessLevel>
  <DefaultWriteAccessLevelBetween>AA==</DefaultWriteAccessLevelBetween>
  <DefaultWriteAccessLevelGreaterThan>0</DefaultWriteAccessLevelGreaterThan>
  <DefaultWriteAccessLevelGreaterThanOrEqualTo>0</DefaultWriteAccessLevelGreaterThanOrEqualTo>
  <DefaultWriteAccessLevelIn>AA==</DefaultWriteAccessLevelIn>
  <DefaultWriteAccessLevelLessThan>0</DefaultWriteAccessLevelLessThan>
  <DefaultWriteAccessLevelLessThanOrEqualTo>0</DefaultWriteAccessLevelLessThanOrEqualTo>
  <DefaultWriteAccessLevelNotEqualTo>0</DefaultWriteAccessLevelNotEqualTo>
  <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>
  <IsDefault>false</IsDefault>
  <IsEnabled>false</IsEnabled>
  <IsReadOnly>false</IsReadOnly>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <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_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>
</SY_UserGroupsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_UserGroups7kRqkrSv 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_UserGroups>
      <d2p1:_x003C_DefaultAbstractAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_DefaultAbstractAccessLevel_x003E_k__BackingField>
      <d2p1:_x003C_DefaultRESTAPIAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_DefaultRESTAPIAccessLevel_x003E_k__BackingField>
      <d2p1:_x003C_DefaultReadAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_DefaultReadAccessLevel_x003E_k__BackingField>
      <d2p1:_x003C_DefaultWriteAccessLevel_x003E_k__BackingField>0</d2p1:_x003C_DefaultWriteAccessLevel_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
      <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d2p1:_x003C_IsReadOnly_x003E_k__BackingField>false</d2p1:_x003C_IsReadOnly_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_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_Menu_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_Menu_RecID_x003E_k__BackingField>
    </d2p1:SY_UserGroups>
  </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_UserGroups7kRqkrSv>