SOAP API – CreateService

CreateService( ownerID, serviceName, description, baseFrequency, baseUnitName, typeName, baseFee, billingPeriodTypeName, showTicketOnTransaction ) : Void

Since: EngageIP v25.2

Create new Service

Parameters:

ownerID (Integer) - The mandatory ID of the owner of the service. An exception will be thrown if the ID cannot be found.
serviceName (String) - The mandatory unique name of the service. An exception will be thrown if the service name is already in use.
description (String) - The mandatory description of the service. Use an empty string for no description.
baseFrequency (int) - The mandatory numeric part of the billing frequency, for example every 3 months.
baseUnitName (String) - The mandatory time unit part of the billing frequency, for example every 3 months. An exception will be thrown if the base unit name does not exist.
typeName (String) - The mandatory service type name. An exception will be thrown if the service type does not exist.
baseFee (Double) - The mandatory fee to be charged for each billing period.
billingPeriodTypeName (String) - The mandatory name of the billing period type. An exception will be thrown if the billing period type does not exist.
showTicketOnTransaction (Boolean) - The mandatory indication of the service will be available for ticket transactions. For more details please see Ticket Transactions Use.

Returns:

Nothing

Possible Exceptions:

INVALID OWNER ID
INVALID SERVICE NAME
INVALID BASE UNIT NAME
INVALID SERVICE TYPE
INVALID BILLING PERIOD TYPE NAME

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <CreateService xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
      <serviceName>string</serviceName>
      <description>string</description>
      <baseFrequency>int</baseFrequency>
      <baseUnitName>string</baseUnitName>
      <typeName>string</typeName>
      <baseFee>double</baseFee>
      <billingPeriodTypeName>string</billingPeriodTypeName>
      <showTicketOnTransaction>boolean</showTicketOnTransaction>
    </CreateService>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateServiceResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/CreateService"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <CreateService xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
      <serviceName>string</serviceName>
      <description>string</description>
      <baseFrequency>int</baseFrequency>
      <baseUnitName>string</baseUnitName>
      <typeName>string</typeName>
      <baseFee>double</baseFee>
      <billingPeriodTypeName>string</billingPeriodTypeName>
      <showTicketOnTransaction>boolean</showTicketOnTransaction>
    </CreateService>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateServiceResponse xmlns="Logisense_EngageIP" />
  </soap:Body>
</soap:Envelope>