Overview
This API permits the activation of a service.
To retrieve a list of service types:
- Create a login token via the login API call.
- Specify the AccountPresaleSQID or the service identifier and service type ID.
- Specify the SIM number if required.
- Specify the Product, if required.
Business Rules
Different service types will have have different requirements.
Service Type: TelstraMarketExtender
If the Retail Service Provider only has one product where the Product type is a SIM card, and the product has a matching service type category to this service type, it will use the SIM from the inventory of this Product. If there is more than one Product matching these conditions, you will be required to provide a Product ID in the API call.
SOAP Example
Request - SQ_ID only
<urn:ActivateService> <urn:loginToken>e4d723bfafeaeecc4cc91da481ad2dca896134df44a73ed225a23a5401aeefe1</urn:loginToken> <urn:SQ_ID>581407</urn:SQ_ID> <urn:sim_number>498172577</urn:sim_number> </urn:ActivateService>
Request - With Service Identifier
<urn:ActivateService> <urn:loginToken>e4d723bfafeaeecc4cc91da481ad2dca896134df44a73ed225a23a5401aeefe1</urn:loginToken> <urn:service_identifier>581407</urn:service_identifier> <urn:service_type_id>5702</urn:service_type_id> <urn:sim_number>498172577</urn:sim_number> </urn:ActivateService>
Response
<ns1:ActiveServiceResponse>true</ns1:ActiveServiceResponse>
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 |
|---|---|---|---|---|---|
loginToken | The authentication token as it was returned by the Authentication/login API call. | Yes | String | 64 | a valid session token. |
| sq_id | The account presale service qualification id. This can be retrieved via one of the service provider sq calls documented here. This will be mandatory if a service_identifier is not provided in this call. | No | Integer | 5434323 | |
| service_identifier | The identifier you are trying to activate. If sq_id is provided, this field will be mandatory. | No | String | 61464917053 | |
| service_type_id | The service type id associated with the service you are trying to activate. This will be mandatory if you are only providing a service identifier to activate as opposed to the sq_id. | No | Integer | 5702 | |
| sim_number | Where the product_id is required and the product bears the category "SIM Card", you will be required to provide a sim_number that is in "Held" status and not locked. | No | Integer | 45454345445 | |
| product_id | Some service types will require you to provide a product_id. See the Business Rules in this section to see whether this applies to the service type associated with the service you are trying to activate. | No | Integer | 42123212 |