METHOD Operation

The METHOD operation permits client applications to make calls to SmartOffices predefined business rules. Predefined business rules are actually methods of EJBs in SmartOffice.

SmartIntegrator parses the request XML to retrieve all of the parameters and then calls the correspondent EJB method before finally wrapping the result in the response XML.

Each method has different parameters and return values. Details should be enclosed when publishing a method.

Sample:

Request XML
<request version='1.0'>
  <header>
    <office>myoffice</office>
    <user>jdoe</user>
    <password>password</password>
  </header>
  <method>
    <GetHouseholdMember>
      <ContactID>Contact.1.3</ContactID>
    </GetHouseholdMember>
  </method>
</request>

Response XML
<response version="1.0">
  <header>
    <sessionClosed/>
  </header>
  <method>
    <GetHouseholdMember>
      <HouseHold id="HouseHold.1.1" _type="obj">
        <Name>Burns Household</Name>
        <HouseHoldMembers _type="objs">
          <HouseHoldMember id="HouseHoldMember.1.2" _type="obj">
            <Member>Child</Member>
            <Contact id="Contact.1.4" _type="obj">
              <FirstName>Sasha</FirstName>
              <LastName>Burns</LastName>
            </Contact>
          </HouseHoldMember>
          <HouseHoldMember id="HouseHoldMember.1.1" _type="obj">
            <Member>Head</Member>
            <Contact id="Contact.1.3" _type="obj">
              <FirstName>Pearl</FirstName>
              <LastName>Burns</LastName>
            </Contact>
          </HouseHoldMember>
        </HouseHoldMembers>
      </HouseHold>
    </GetHouseholdMember>
  </method>
  <_status>OK</_status>
  <_systime>2015-06-03T20:04:29</_systime>
  <!--Cost 51 mill seconds.-->
</response>

Documented Methods

These methods will be enhanced and explained over time based on demand.



Topic revision: 27 Sep 2017, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback