Page History

Include Page

spaceKey	Grouper
pageTitle	Navigation

Grouper Web Services

How does paging work with web services

Unfortunately you cannot get back the total count in the result, so you can page. If the result size is less than page size, then there is not another page. If not, make another query and see if there are more results.
Paging with cursor is better than paging without cursor since records can be skipped if they are edited while the paging is taking place

These examples are for getGroups, example URL and headers:

Code Block
POST https://grouper-ws.school.edu/grouperWs/servicesRest/v4_0_000/subjects/sources/pennperson/subjectId/10021368/groups Content-Type: application/x-www-form-urlencoded

Paging with cursor example (recommended)

Request first page (pick a sort field and if ascending, in this case getting all so just use id)
Code Block
wsLiteObjectType=WsRestGetGroupsLiteRequest&sortString=id&ascending=true&pageSize=3&pageNumber=1

Request next page (note the page last cursor field is the last id sent in previous request (cursor)

Code Block

wsLiteObjectType=WsRestGetGroupsLiteRequest&sortString=id&ascending=true&pageSize=3&pageLastCursorFieldType=string&pageCursorFieldIncludesLastRetrieved=false&pageIsCursor=true&pageLastCursorField=00ffd24ae5f84e6ebb68b1779577c0cd

Paging without cursor example (not recommended)

Request first page

Code Block
wsLiteObjectType=WsRestGetGroupsLiteRequest&sortString=id&ascending=true&pageSize=3&pageNumber=1

Request next page

Code Block
wsLiteObjectType=WsRestGetGroupsLiteRequest&sortString=id&ascending=true&pageSize=3&pageNumber=2

Subject attributes can be exposed via web service

First off, you need to have the subject api configuration to get attribute from the DB / LDAP

Here is an example from a JDBC2 subject source

Code Block

# now you can count up from 0 to N of attributes for various cols.  The name is how to reference in subject.getAttribute()
subjectApi.source.pennperson.param.subjectAttributeCol0.value = pennname

# you can count up from 0 to N of attributes for various cols.  The name is how to reference in subject.getAttribute()
subjectApi.source.pennperson.param.subjectAttributeName0.value = PENNNAME

You can test this from GSH

Code Block

groovy:000> grouperSession = GrouperSession.startRootSession();
===> 4a29e140d3b346558c7c23ed996d1d8a,'GrouperSystem','application'
groovy:000> subject = SubjectFinder.findByIdOrIdentifier("mchyzer", true);
===> Subject id: 10021368, sourceId: pennperson, name: Chris Hyzer
groovy:000> subject.getAttributeValue("pennname")
===> mchyzer

Subject attributes are exposed via web service in the grouper-ws.properties

Code Block

# subject attribute names to send back when a WsSubjectResult is sent, comma separated                                              
# e.g. name, netid                                                                                                                  
# default is none                                                                                                                   
ws.subject.result.attribute.names =

# subject result attribute names when extended data is requested (comma separated)                                                  
# default is name, description                                                                                                      
# note, these will be in addition to ws.subject.result.attribute.names                                                              
ws.subject.result.detail.attribute.names = PENNNAME

Then when a subject is returned, since ws.subject.result.attribute.names is blank, no custom attribute are returned by default

Code Block

[mchyzer@flash pennGroupsClient-2.4.0]$ java -jar grouperClient.jar --operation=getSubjectsWs --subjectIdentifiers=mchyzer --debug=true
Reading resource: grouper.client.properties, from: /home/mchyzer/grouper/pennGroupsClient-2.4.0/grouper.client.properties
WebService: connecting as user: 'someuser'
WebService: connecting to URL: 'https://server.school.edu/grouperWs/servicesRest/v2_4_000/subjects'

################ REQUEST START (indented) ###############

POST /grouperWs/servicesRest/v2_4_000/subjects HTTP/1.1
Connection: close
Authorization: Basic xxxxxxxxxxxxxxxx
User-Agent: Jakarta Commons-HttpClient/3.1
Host: somehost.school.edu:-1
Content-Length: 171
Content-Type: text/xml; charset=UTF-8

<WsRestGetSubjectsRequest>
  <wsSubjectLookups>
    <WsSubjectLookup>
      <subjectIdentifier>mchyzer</subjectIdentifier>
    </WsSubjectLookup>
  </wsSubjectLookups>
</WsRestGetSubjectsRequest>

################ REQUEST END ###############



################ RESPONSE START (indented) ###############

HTTP/1.1 200 OK
Date: Wed, 17 Apr 2019 18:12:37 GMT
Set-Cookie: JSESSIONID=xxxxxxxxxxxx; HttpOnly
X-Grouper-resultCode: SUCCESS
X-Grouper-success: T
X-Grouper-resultCode2: NONE
Content-Type: application/xml;charset=UTF-8
Vary: Accept-Encoding
Connection: close
Transfer-Encoding: chunked

<WsGetSubjectsResults>
  <wsSubjects>
    <WsSubject>
      <identifierLookup>mchyzer</identifierLookup>
      <resultCode>SUCCESS</resultCode>
      <success>T</success>
      <id>10021368</id>
      <name>Chris Hyzer</name>
      <sourceId>pennperson</sourceId>
    </WsSubject>
  </wsSubjects>
  <resultMetadata>
    <resultCode>SUCCESS</resultCode>
    <resultMessage>Queried 1 subjects</resultMessage>
    <success>T</success>
  </resultMetadata>
  <responseMetadata>
    <resultWarnings></resultWarnings>
    <millis>11</millis>
    <serverVersion>2.4.0</serverVersion>
  </responseMetadata>
</WsGetSubjectsResults>

################ RESPONSE END ###############


Output template: Index: ${index}: success: ${success}, code: ${wsSubject.resultCode}, subject: ${wsSubject.id}, available variables: wsGetSubjectsResults, grouperClientUtils, index, wsSubject, wsGroup, success
Index: 0: success: T, code: SUCCESS, subject: 10021368
Elapsed time: 957ms
[mchyzer@flash pennGroupsClient-2.4.0]$

If you request the subject detail (attrs in ws.subject.result.detail.attribute.name), then they will be returned

Code Block

[mchyzer@flash pennGroupsClient-2.4.0]$ java -jar grouperClient.jar --operation=getSubjectsWs --subjectIdentifiers=mchyzer --debug=true --includeSubjectDetail=true
Reading resource: grouper.client.properties, from: /home/mchyzer/grouper/pennGroupsClient-2.4.0/grouper.client.properties
WebService: connecting as user: 'user'
WebService: connecting to URL: 'https://server.school.edu/grouperWs/servicesRest/v2_4_000/subjects'

################ REQUEST START (indented) ###############

POST /grouperWs/servicesRest/v2_4_000/subjects HTTP/1.1
Connection: close
Authorization: Basic xxxxxxxxxxxxxxxx
User-Agent: Jakarta Commons-HttpClient/3.1
Host: fastprod-medium-a-01.apps.upenn.edu:-1
Content-Length: 217
Content-Type: text/xml; charset=UTF-8

<WsRestGetSubjectsRequest>
  <includeSubjectDetail>T</includeSubjectDetail>
  <wsSubjectLookups>
    <WsSubjectLookup>
      <subjectIdentifier>mchyzer</subjectIdentifier>
    </WsSubjectLookup>
  </wsSubjectLookups>
</WsRestGetSubjectsRequest>

################ REQUEST END ###############



################ RESPONSE START (indented) ###############

HTTP/1.1 200 OK
Date: Wed, 17 Apr 2019 18:16:55 GMT
Set-Cookie: JSESSIONID=xxxxxxxxxxxx; HttpOnly
X-Grouper-resultCode: SUCCESS
X-Grouper-success: T
X-Grouper-resultCode2: NONE
Content-Type: application/xml;charset=UTF-8
Vary: Accept-Encoding
Connection: close
Transfer-Encoding: chunked

<WsGetSubjectsResults>
  <subjectAttributeNames>
    <string>name</string>
    <string>description</string>
    <string>PENNNAME</string>
    <string>EMAIL</string>
  </subjectAttributeNames>
  <wsSubjects>
    <WsSubject>
      <identifierLookup>mchyzer</identifierLookup>
      <resultCode>SUCCESS</resultCode>
      <success>T</success>
      <id>10021368</id>
      <name>Chris Hyzer</name>
      <sourceId>pennperson</sourceId>
      <attributeValues>
        <string>Chris Hyzer</string>
        <string>Chris Hyzer (mchyzer, 10021368) (active) Staff - Isc-applications & Information Services - Application Architect (also: Alumni)</string>
        <string>mchyzer</string>
        <string>mchyzer@upenn.edu</string>
      </attributeValues>
    </WsSubject>
  </wsSubjects>
  <resultMetadata>
    <resultCode>SUCCESS</resultCode>
    <resultMessage>Queried 1 subjects</resultMessage>
    <success>T</success>
  </resultMetadata>
  <responseMetadata>
    <resultWarnings></resultWarnings>
    <millis>121</millis>
    <serverVersion>2.4.0</serverVersion>
  </responseMetadata>
</WsGetSubjectsResults>

################ RESPONSE END ###############


Output template: Index: ${index}: success: ${success}, code: ${wsSubject.resultCode}, subject: ${wsSubject.id}, available variables: wsGetSubjectsResults, grouperClientUtils, index, wsSubject, wsGroup, success
Index: 0: success: T, code: SUCCESS, subject: 10021368
Elapsed time: 1106ms
[mchyzer@flash pennGroupsClient-2.4.0]$

Or you can request individual attributes

Code Block

[mchyzer@flash pennGroupsClient-2.4.0]$ java -jar grouperClient.jar --operation=getSubjectsWs --subjectIdentifiers=mchyzer --debug=true --subjectAttributeNames=PENNNAME
Reading resource: grouper.client.properties, from: /home/mchyzer/grouper/pennGroupsClient-2.4.0/grouper.client.properties
WebService: connecting as user: 'user'
WebService: connecting to URL: 'https://server.school.edu/grouperWs/servicesRest/v2_4_000/subjects'

################ REQUEST START (indented) ###############

POST /grouperWs/servicesRest/v2_4_000/subjects HTTP/1.1
Connection: close
Authorization: Basic xxxxxxxxxxxxxxxx
User-Agent: Jakarta Commons-HttpClient/3.1
Host: fastprod-medium-a-01.apps.upenn.edu:-1
Content-Length: 243
Content-Type: text/xml; charset=UTF-8

<WsRestGetSubjectsRequest>
  <subjectAttributeNames>
    <string>PENNNAME</string>
  </subjectAttributeNames>
  <wsSubjectLookups>
    <WsSubjectLookup>
      <subjectIdentifier>mchyzer</subjectIdentifier>
    </WsSubjectLookup>
  </wsSubjectLookups>
</WsRestGetSubjectsRequest>

################ REQUEST END ###############



################ RESPONSE START (indented) ###############

HTTP/1.1 200 OK
Date: Wed, 17 Apr 2019 18:26:29 GMT
Set-Cookie: JSESSIONID=xxxxxxxxxxxx; HttpOnly
X-Grouper-resultCode: SUCCESS
X-Grouper-success: T
X-Grouper-resultCode2: NONE
Content-Type: application/xml;charset=UTF-8
Vary: Accept-Encoding
Connection: close
Transfer-Encoding: chunked

<WsGetSubjectsResults>
  <subjectAttributeNames>
    <string>PENNNAME</string>
  </subjectAttributeNames>
  <wsSubjects>
    <WsSubject>
      <identifierLookup>mchyzer</identifierLookup>
      <resultCode>SUCCESS</resultCode>
      <success>T</success>
      <id>10021368</id>
      <name>Chris Hyzer</name>
      <sourceId>pennperson</sourceId>
      <attributeValues>
        <string>mchyzer</string>
      </attributeValues>
    </WsSubject>
  </wsSubjects>
  <resultMetadata>
    <resultCode>SUCCESS</resultCode>
    <resultMessage>Queried 1 subjects</resultMessage>
    <success>T</success>
  </resultMetadata>
  <responseMetadata>
    <resultWarnings></resultWarnings>
    <millis>207</millis>
    <serverVersion>2.4.0</serverVersion>
  </responseMetadata>
</WsGetSubjectsResults>

################ RESPONSE END ###############


Output template: Index: ${index}: success: ${success}, code: ${wsSubject.resultCode}, subject: ${wsSubject.id}, available variables: wsGetSubjectsResults, grouperClientUtils, index, wsSubject, wsGroup, success
Index: 0: success: T, code: SUCCESS, subject: 10021368
Elapsed time: 1180ms
[mchyzer@flash pennGroupsClient-2.4.0]$

dsf

Which SOAP call should I use for getting the list of groups that group A is a member of?

...

Page tree

Versions Compared

Old Version 7

New Version Current

Key