Go to full article


Overview

The purpose of this call is to activate preactive services.

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

ActivateServiceSubscription



Business Rules

 It is not intended that this call can be used to activate a service on any service type regardless of the provisioning method or transfer type.  The rules are as follows:

  • The subscription cannot be part of a migration and the transfer type of the subscription must be "NEW" (this means subscriptions with transfer types of CHURN,CHOWN,UPGRADE cannot be activated with this call).
  • The subscription ID must be the lowest in the subscription hierachy.
  • The subscription must be preactive.
  • The subscription is owned by an account of the parent calling the API (in effect, only the RSP can activate the service). In addition provisioning for the RSP must be controlled by RSP and not another entity (for example, a wholesale account).
  • The subscription must have a core identifier.
  • Activation Dates must be today's date or in the past, but not before the account start date and not prior to the package subscription start date.
  • If you elect to set service quantities, this must be supported by the Service Type.
  • If a service identifier exists, it can't be present on another service on the same service type.
  • The service  type must not be configured for automated provisioning.
  • If the service requires core identifiers with a realm, it cannot be changed at the activate stage in this API call.




SOAP Example


API Call
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ActivateServiceSubscription>
         <urn:ServiceSubscriptionID>4077451</urn:ServiceSubscriptionID>
         <!--Optional:-->
         <urn:StartDate>2021-05-13</urn:StartDate>
         <!--Optional:-->
         <urn:ServiceIdentifier>61391123445</urn:ServiceIdentifier>
         <!--Optional:-->
         <urn:ServiceQuantity>3</urn:ServiceQuantity>
      </urn:ActivateServiceSubscription>
   </soapenv:Body>
</soapenv:Envelope>
API Successful Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:ActivateServiceSubscriptionResponse/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Values

ServiceSubscriptionID

Lowest tier service subscription ID for a preactive service.YesInteger

Y



StartDate

Start Date of the service. If a start date is not provided, the current date as of the timezone set on the service will be applied.NoDate
2021-05-13

ServiceIdentifier

Core Identifier of the service.  If it is presently set against the preactive subscription, values here will overwrite the existing core identifier.NoString
Valid identifiers will depend on the service type and validation requirements for that service type.

ServiceQuantity

Quantity for the Service.NoInteger
4



Error Handling


Error MessageDescription

Invalid ServiceSubscriptionID

This error will generally arise if the subscription belongs to an account that is not a child of the RSP performing the API call.  It may also arise if there is data problems with the subscription.
Subscription status is not Pre-Active
Subscription is part of a migration
Subscription is part of a service transferThis error will arise if the transfer type of the service is not "New".
Service does not have a core identifier
Service type is configured for automated provisioning.
StartDate is earlier than Package Subscription start date
StartDate is earlier than Account Start Date
ServiceIdentifier value exceeds maximum length
ServiceQuantity is not supported by the Service Type
ServiceQuantity is below Service Plan minimum
ServiceQuantity is above the Service Plan maximum
Service is missing required propertiesSome service types require service properties to be set, typically done at the service configuration stage of an order.  If those properties are mandatory and not set, the API will return this error message.
Service type is configured for provisioning by parent accountThe most likely reason for this error is the service type is mapped to a wholesale account, that is the parent of the RSP who is performing the API call.