AbodeONE

<back to all web services

FindStudentGroup

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/student_groups
FindStudentGroupResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<StudentGroupDTO>No
ResponseStatusformResponseStatusNo
StudentGroupDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
FilterformGroupFilterNo
GroupFilter Parameters:
NameParameterData TypeRequiredDescription
IncludesformList<int>No
ExcludesformList<int>No
exprformFilterExpressionNo
FilterExpression Parameters:
NameParameterData TypeRequiredDescription
FieldformstringNo
OpformstringNo
ValueformObjectNo
SubExprformList<FilterExpression>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.

GET //student_groups HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FindStudentGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <StudentGroupDTO>
      <Description>String</Description>
      <Filter>
        <Excludes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </Excludes>
        <Includes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </Includes>
        <expr>
          <Field>String</Field>
          <Op>String</Op>
          <SubExpr>
            <FilterExpression>
              <Field>String</Field>
              <Op>String</Op>
              <SubExpr>
                <FilterExpression>
                  <Field>String</Field>
                  <Op>String</Op>
                  <SubExpr>
                    <FilterExpression i:nil="true" />
                  </SubExpr>
                  <Value />
                </FilterExpression>
              </SubExpr>
              <Value />
            </FilterExpression>
          </SubExpr>
          <Value />
        </expr>
      </Filter>
      <Id>0</Id>
      <Name>String</Name>
    </StudentGroupDTO>
  </Results>
</FindStudentGroupResponse>