GetFacadeObjectList

Initial Build	2006.2
xWeb	Web Method
Response Type	Object List

This method returns a list of the netFORUM facade objects in the system. This list displays the objects that come bundled with the netFORUM application and also any client-created objects.

Object Name Property

The <obj_name> property in the response should be used as the szObjectName parameter in many other web methods. The <obj_description> is a "friendly" name that provides more information about the object.

Here is what the object looks like in the response of this web method, looking at Subscription in particular:

<ObjectObject>
<obj_name>ProductSubscription</obj_name>
<obj_key>22210b27-2396-48f0-a6a7-5e1a8eb9bda6</obj_key>
<obj_description>Subscription</obj_description>
</ObjectObject>

If you want to call GetQuery or GetFacadeXMLSchema or other web methods for the Subscription object, then use ProductSubscription for the szObjectName parameter; do not use Subscription. If you were to pass Subscription, then you will get unpredictable errors because netFORUM will not be able to find this object.

You will find cases where the <obj_name> and <obj_description> are identical, and some in which they are the same but the obj_name removes spaces, and some which have totally different words; see below for a few more examples in no particular order. Unfortunately there is not always consistency. Bottom line, be sure to use <obj_name>.

<ObjectObject>
<obj_name>Abstract Reviewer</obj_name>
<obj_key>74a11d45-ec60-4961-a976-480408610e8c</obj_key>
<obj_description>Abstract Reviewer</obj_description>
</ObjectObject>
<ObjectObject>
<obj_name>Survey</obj_name>
<obj_key>e4b15169-86c2-4a66-9b30-fa1c48e6c557</obj_key>
<obj_description>Survey</obj_description>
</ObjectObject>
<ObjectObject>
<obj_name>SubscriptionFulfillmentBatch</obj_name>
<obj_key>d2b07e1d-30c7-4d35-8548-5c26f1afb24e</obj_key>
<obj_description>Subscription Fulfillment Batch</obj_description>
</ObjectObject>
<ObjectObject>
<obj_name>CO_Customer_X_Customer</obj_name>
<obj_key>161f7f7d-db36-49b0-91a0-553f57f0520f</obj_key>
<obj_description>Relationships</obj_description>
 </ObjectObject>

Sample Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Header>
<m:AuthorizationToken xmlns:m="http://www.avectra.com/2005/">
<m:Token>17895d9f-f205-49cf-b3da-039e6f7fa82f</m:Token>
</m:AuthorizationToken>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<m:GetFacadeObjectList xmlns:m="http://www.avectra.com/2005/"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

Note: This response is shortened for brevity.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>f8d15d9d-ebce-4831-b1f2-1f2f05bc010c</Token>
</AuthorizationToken>
<wsa:Action>http://www.avectra.com/2005/GetFacadeObjectListResponse</wsa:Action>
<wsa:MessageID>uuid:e9342119-4610-4958-b340-4a696e4c9cbe</wsa:MessageID>
<wsa:RelatesTo>uuid:0ac1f44e-33e3-4bf4-b08f-0aec1b9e030b</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-ab2b6895-2e0e-4a3f-b2ca-d85e58717f0d">
<wsu:Created>2006-09-21T19:51:02Z</wsu:Created>
<wsu:Expires>2006-09-21T19:56:02Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<GetFacadeObjectListResponse xmlns="http://www.avectra.com/2005/">
<GetFacadeObjectListResult>
<ObjectObjects xsi:schemaLocation="http://www.avectra.com/2005/ Object.xsd" recordReturn="684">
<ObjectObject>
<obj_key>9f19379e-0f76-49f9-b945-236dbe0876f7</obj_key>
<obj_description>Abstract Author</obj_description>
<obj_name>Abstract Author</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>ce91cc89-f26d-4ba5-9fa9-a911c448998d</obj_key>
<obj_description>Abstract Category</obj_description>
<obj_name>AbstractCategory</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>74a11d45-ec60-4961-a976-480408610e8c</obj_key>
<obj_description>Abstract Reviewer</obj_description>
<obj_name>Abstract Reviewer</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>8365d1b0-a377-41ff-8df0-1156edbdcd8a</obj_key>
<obj_description>Abstract Reviewer Response</obj_description>
<obj_name>Abstract Reviewer Response</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>0e14ae0d-93df-4da6-b564-32f31ff55e28</obj_key>
<obj_description>Abstract Reviewer Submission</obj_description>
<obj_name>AbstractReviewerSubmission</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>fd3bfa68-6271-483c-b175-d823852e0b36</obj_key>
<obj_description>Abstract Status</obj_description>
<obj_name>AbstractStatus</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>8f2caa2b-73ec-4ec7-b0ba-e8b4be6c4422</obj_key>
<obj_description>Abstract Submission</obj_description>
<obj_name>Abstract Submission</obj_name>
</ObjectObject>
<ObjectObject>
<obj_key>38e7dac4-5dca-4014-ac68-3068707e7010</obj_key>
<obj_description>Accounting Period</obj_description>
<obj_name>AccountingPeriod</obj_name>
</ObjectObject>
</ObjectObjects>
</GetFacadeObjectListResult>
</GetFacadeObjectListResponse>
</soap:Body>
</soap:Envelope>