Page History

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall> 
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>LISTPERSONFAVOURITES</function>
            <favourite>
            	<personId>5</personId>
            </favourite>     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <personfavourites>
               <contentId>61209</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <personfavourites>
               <contentId>61250</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <sessionId>09123071f17afb11be74ca07a6d25aef</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:
  
  

  Code Block
  language java
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("LISTPERSONFAVOURITES");

• Identify a user by using a PersonFavourite object:

  Code Block
  language java
  PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073);

• The following steps are optional, and can be included to filter the response of this call.

  • To retrieve the user's favourite reports:

    Code Block
    language java
    pf.setContentType("REPORT"); pf.setFavouriteType("FAVOURITE");

    
    
    

  • To retrieve all of the user's dashboard:

    Code Block
    language java
    pf.setContentType("REPORTGROUP"); pf.setFavouriteType("REPORTDASHBOARD");

    
    
    

  • To retrieve reports and dashboards distributed to the user:

    Code Block
    language java
    pf.setContentType("REPORTGROUP"); // use this for dashboards, or pf.setContentType("REPORT") to get distributed reports pf.setFavouriteType("INBOX");

    
    
    

  • To retrieve discussions that the user is a member of:

    Code Block
    language java
    pf.setContentType("DISCUSSIONGROUP"); pf.setFavouriteType("DISCUSSIONMEMBER");

    
    
    

  • To retrieve user's favourite views:

    Code Block
    language java
    pf.setContentType("REPORTVIEW");

    
    
    

  • To retrieve user's favourite storyboards:

    Code Block
    language java
    pf.setContentType("STORYBOARD"); pf.setFavouriteType("FAVOURITE");

    
    
    

  • To get user's profile image:

    Code Block
    language java
    pf.setContentType("IMAGE"); pf.setFavouriteType("PROFILE");

    
    
    

  • To retrieve report comments flagged by the user:

    Code Block
    language java
    pf.setContentType("COMMENT"); pf.setFavouriteType("FLAGGED");

    
    
    

• Add this object to the request:

  Code Block
  language java
  rsr.setFavourite(pf);

  
  
  

• Once the request is configured, perform the call:

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  Initialize the Administration web service. Click here to learn how to do this. 

• The response will contain the StatusCode and PersonFavourites parameters. See the Response Parameter table above for details on this.

   

<%        	
/*          	ws_listpersonfavourites.jsp                                 	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin webservices admin account
rsr.setPassword("test");                                                    	// change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LISTPERSONFAVOURITES");
 
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentType("REPORT");
 
rsr.setFavourite(pf);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
           out.write("<br>Success");
           if (rs.getPersonfavourites() != null)
           for (PersonFavourite f: pf){
                out.write("<br><br>contentId: " + f.getContentId());
            	out.write("<br>ContentType: " + f.getContentType());
            	out.write("<br>CreationCode: " + f.getCreationCode());
   	     		out.write("<br>CreationDate: " + f.getCreationDate());
           		out.write("<br>CreatorId: " + f.getCreatorId());
            	out.write("<br>FavouriteType: " + f.getFavouriteType());
        		out.write("<br>Message: " + f.getMessage());
     	    	out.write("<br>PersonId: " + f.getPersonId());
            	out.write("<br>textEntityId: " + f.getTextEntityId());
           }
} else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
}
%>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall> 
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>REMOVEPERSONFAVOURITE</function>
            <favourite>
            	<personId>13000</personId>
            	<contentType>REPORTGROUP</contentType>
            	<contentId>61209</contentId>
            </favourite>     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>0cc3673ed857e1e28fb0e326b8f3b24e</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:
  
  

  Code Block
  language java
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("REMOVEPERSONFAVOURITE");

• Identify a user throught the PersonFavourite object:

  Code Block
  language java
  PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073);

• Specify the objects that are to be removed as favourites in this object:
  
  

  Code Block
  language java
  pf.setContentId(61252); pf.setContentType("REPORTVIEW");

  
  
  

• Add this object to the request:

  Code Block
  language java
  rsr.setFavourite(pf);

  
  
  

• Once the request is configured, perform the call:

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  Initialize the Administration web service. Click here to learn how to do this. 

• The response will contain the StatusCode parameter. See the Response Parameter table above for details on this.

   

<%        	
/*          	ws_removepersonfavourite.jsp                          	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      		// provide your Yellowfin web services admin account
rsr.setPassword("test");                            // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("REMOVEPERSONFAVOURITE");
 
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(70270);
pf.setContentType("REPORTVIEW");
 
rsr.setFavourite(pf);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
              	out.write("<br>Success");
              	
} else {
              	out.write("Failure");
              	out.write(" Code: " + rs.getErrorCode());
}
%>