Overview
The purpose of this call is to set a start date against a preactive service subscription.
WSDL
https://api.emersion.com.au/Services.wsdl
Operation name
SetStartDateOnPreactiveServiceSubscriptionBusiness Rules
- Service subscription must be preactive
- Service subscription must be owned by caller account
- Service subscription must be at the bottom tier (i.e. at the end user account level)
SOAP Example
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
<soapenv:Header/>
<soapenv:Body>
<urn:SetStartDateOnPreactiveServiceSubscription>
<urn:ServiceSubscriptionID>100805</urn:ServiceSubscriptionID>
<urn:StartDate>2021-08-29</urn:StartDate>
</urn:SetStartDateOnPreactiveServiceSubscription>
</soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
<SOAP-ENV:Body>
<ns1:SetStartDateOnPreactiveServiceSubscriptionResponse/>
</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..
| Name | Description | Required? | Field Type | Character limit | Values |
|---|---|---|---|---|---|
ServiceSubscriptionID | ID of the service subscription, for which, the start date is being set | Yes | Integer | e.g. 100000 | |
StartDate | The date that needs to be set as the start date | Yes | Date | e.g. 2021-08-29 |
Error Handling
| Error Message | Description |
|---|---|
Service Subscription ID must be provided | |
Service Subscription ID must be integer | |
Service Subscription ID not found | When the ID is not found in Emersion database |
Service Subscription is not Preactive | |
Service Subscription is not the bottom level | |
Service Subscription is not owned by the | |
Start Date must be provided | |
Invalid Start Date provided | When date format is incorrect. Should be YYYY-MM-DD |