getServiceDescription()

ServiceDescription getServiceDescription(int sid)

This method retrieves information about a service, including metadata stored in custom fields. Use this method to display service information in a web application and to access custom field metadata that describes how to display the information.

Parameters

sid
Format: integer
Purpose: Specifies the service ID.

Results

This method returns a ServiceDescription XML document that contains the service name, custom field information and the subscription order form for this service.

There are no messages defined by this method.

Note: For more information about subscription order forms, see getAvailableOrderForms().

Example: A returned ServiceDescription XML document

This example shows a returned ServiceDescription XML document for an ADSL service with SID 1203.

<ServiceDescription xmlns="http://xml.inomial.com/smile/2.xsd">
  <SID>1203</SID>
  <name>ADSL</name>
  <ServiceProperties>
    <Object/>
  </ServiceProperties>
  <SubscriptionForm>
    <Form>
      <Name>ADSL</Name>
      <Attributes>
        <Attribute>
          <Required>false</Required>
          <Label>Stability Profile</Label>
          <Visibility>VisibleAndEditable</Visibility>
          <AttributeType>  
            <AttributeType>122</AttributeType>
            <Label>Stability Profile</Label>
            <SmileObjectXMLType type="Boolean"/>  
          </AttributeType>
        </Attribute>  
      </Attributes>
    </Form>  
  </SubscriptionForm>
</ServiceDescription>

Faults

ServiceDescriptionException

This fault is returned when the service does not exist or the caller does not have permission to perform this action.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetServiceDescription sid
sid
Purpose: Specifies the service ID.
Note: For more information about the Java client and the options it accepts, see Java client syntax.