JiwaAPI

<back to all web services

SY_UserGroupRESTAPIPermissionsQuery

Requires Authentication
SY_UserGroupRESTAPIPermissionsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
SY_UserGroups_RecIDqueryGuid?No
SY_UserGroups_RecIDInqueryGuid[]No
RESTPathquerystringNo
RESTPathStartsWithquerystringNo
RESTPathEndsWithquerystringNo
RESTPathContainsquerystringNo
RESTPathLikequerystringNo
RESTPathBetweenquerystring[]No
RESTPathInquerystring[]No
VerbquerystringNo
VerbStartsWithquerystringNo
VerbEndsWithquerystringNo
VerbContainsquerystringNo
VerbLikequerystringNo
VerbBetweenquerystring[]No
VerbInquerystring[]No
SummaryquerystringNo
SummaryStartsWithquerystringNo
SummaryEndsWithquerystringNo
SummaryContainsquerystringNo
SummaryLikequerystringNo
SummaryBetweenquerystring[]No
SummaryInquerystring[]No
AccessLevelquerybyte?No
AccessLevelGreaterThanOrEqualToquerybyte?No
AccessLevelGreaterThanquerybyte?No
AccessLevelLessThanquerybyte?No
AccessLevelLessThanOrEqualToquerybyte?No
AccessLevelNotEqualToquerybyte?No
AccessLevelBetweenquerybyte[]No
AccessLevelInquerybyte[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_UserGroupRESTAPIPermissions Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_UserGroups_RecIDformGuidNo
RESTPathformstringNo
VerbformstringNo
SummaryformstringNo
AccessLevelformbyteNo
ItemNoformintNo
RowHashformbyte[]No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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_UserGroupRESTAPIPermissionsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_UserGroupRESTAPIPermissionsQuery 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>
  <AccessLevel>0</AccessLevel>
  <AccessLevelBetween>AA==</AccessLevelBetween>
  <AccessLevelGreaterThan>0</AccessLevelGreaterThan>
  <AccessLevelGreaterThanOrEqualTo>0</AccessLevelGreaterThanOrEqualTo>
  <AccessLevelIn>AA==</AccessLevelIn>
  <AccessLevelLessThan>0</AccessLevelLessThan>
  <AccessLevelLessThanOrEqualTo>0</AccessLevelLessThanOrEqualTo>
  <AccessLevelNotEqualTo>0</AccessLevelNotEqualTo>
  <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>
  <RESTPath>String</RESTPath>
  <RESTPathBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RESTPathBetween>
  <RESTPathContains>String</RESTPathContains>
  <RESTPathEndsWith>String</RESTPathEndsWith>
  <RESTPathIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RESTPathIn>
  <RESTPathLike>String</RESTPathLike>
  <RESTPathStartsWith>String</RESTPathStartsWith>
  <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_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>
  <Summary>String</Summary>
  <SummaryBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SummaryBetween>
  <SummaryContains>String</SummaryContains>
  <SummaryEndsWith>String</SummaryEndsWith>
  <SummaryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SummaryIn>
  <SummaryLike>String</SummaryLike>
  <SummaryStartsWith>String</SummaryStartsWith>
  <Verb>String</Verb>
  <VerbBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VerbBetween>
  <VerbContains>String</VerbContains>
  <VerbEndsWith>String</VerbEndsWith>
  <VerbIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VerbIn>
  <VerbLike>String</VerbLike>
  <VerbStartsWith>String</VerbStartsWith>
</SY_UserGroupRESTAPIPermissionsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_UserGroupRESTAPIPermissions7kRqkrSv 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_UserGroupRESTAPIPermissions>
      <d2p1:_x003C_AccessLevel_x003E_k__BackingField>0</d2p1:_x003C_AccessLevel_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_RESTPath_x003E_k__BackingField>String</d2p1:_x003C_RESTPath_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_UserGroups_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_UserGroups_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Summary_x003E_k__BackingField>String</d2p1:_x003C_Summary_x003E_k__BackingField>
      <d2p1:_x003C_Verb_x003E_k__BackingField>String</d2p1:_x003C_Verb_x003E_k__BackingField>
    </d2p1:SY_UserGroupRESTAPIPermissions>
  </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_UserGroupRESTAPIPermissions7kRqkrSv>