Overview
This call can be used to perform a service Qualification on the 'MarketExtender' service type.
To retrieve a list of service types:
- You will first need to run the StartOrder API call in order to obtain an Account PresaleID.
- Create a PerformMarketExenderSQ API call.
- Specify all required parameters.
Business Rules
At this time, Transfer Types of 'CHOWN' and 'UPGRADE' are not available.
If a date of birth is given as Porting Identification, the date must be in the past and greater than 18 yrs in the past.
SOAP Example
Sample Call - NEW Service
<urn:PerformMarketExtenderSQ> <urn:AccountPresaleID>542885</urn:AccountPresaleID> <urn:ServiceTypeID>5593</urn:ServiceTypeID> <urn:TransferType>NEW</urn:TransferType> </urn:PerformMarketExtenderSQ>
Sample Response - NEW Service
<PerformMarketExtenderSQResponse> <AccountPresaleSQID>234234</AccountPresaleSQID> <AvailableTransferType>NEW</AvailableTransferType> <MobileServiceNumber>6143123123</MobileServiceNumber> </PerformMarketExtenderSQResponse>
Sample Call - CHURN Service
<urn:PerformMarketExtenderSQ > <urn:AccountPresaleID>542885</urn:AccountPresaleID> <urn:ServiceTypeID>5593</urn:ServiceTypeID> <urn:TransferType>CHURN</urn:TransferType> <urn:PortingNumber>61439367205</urn:PortingNumber> <urn:PortingType>POSTPAID</urn:PortingType> <urn:PortingIdentificationType>ACCT</urn:PortingIdentificationType> <urn:PortingIdentification>23424343</urn:PortingIdentificationType> </urn:PerformMarketExtenderSQ>
Sample Response - CHURN Service
<PerformMarketExtenderSQResponse> <AccountPresaleSQID>234234</AccountPresaleSQID> <AvailableTransferType>CHURN</AvailableTransferType> <MobileServiceNumber>61439367205</MobileServiceNumber> </PerformMarketExtenderSQResponse>
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 |
|---|---|---|---|---|---|
AccountPresaleID | Account Presale Id obtained via API call StartOrder via the following WSDL (https://api.emersion.com/Orders.wsdl). | Yes | Integer | 543123 | |
TransferType | Indicates the transfer type for the qualification. | Yes | String | CHURN NEW | |
PortingNumber | If you are attempting to port a number from another provider, this field needs to be set. | No | String | 61466917004 | |
| PortingType | This indicates whether the service is currently being billed postpaid or prepaid with the losing provider. Required where the transfer type is CHURN. | No | String | PREPAID POSTPAID | |
| PortingIdentificationType | This field indicates how what type authorisation data you will provide in order to confirm the port. Required where the transfer type is CHURN. | No | String | DOB ACCT | |
| PortingIdentification | The port identification authorisation data. Required where the transfer type is CHURN. | No | String | Where the PortingIdentificationType is DOB you must provide a date i.e.: 01-03-2000 323123354 |
Error Handling
| Error Message | Description |
|---|---|
| Account Presale ID not provided | You must provide an Account Presale ID. This can be retrieved by the StartOder API call located in the following wsdl: https://api.emersion.com/Orders.wsdl |
| Invalid Account Presale ID provided | The ID provided likely to does not exist. |
| Transfer Type not provided | You must provide a transfer type in the order as per the field descriptions in this document. |
| Invalid Transfer Type provided | Only 'NEW' and 'CHURN' are acceptable values. |
| Porting fields can only be provided for CHURN orders | You have attempted to set the portingnumber, portingidentificationtype and or portingtype fields. These fields can only be set where the transfertype is CHURN. |
| All porting fields must be provided for CHURN orders | You have attempted to do an SQ without setting portingnumber, portingidentificationtype and or portingtype fields. These fields must be set when the transfertype is CHURN. |
| Porting Number not in valid format | You have not provided the value in the portingnumber field in the valid format. At present the regex mask is /^(61|0)[45][0-9]{8}$/. |
| Porting Type cannot be blank for CHURN order | You have attempted a churn without specifying a porting number. |
| Porting Type must be either PREPAID or POSTPAID | You have provided an invalid value in the portingtype field. |
| Porting Identification Type cannot be blank for CHURN order | The portingidentificationtype field is required where transfertype field is set to CHURN. |
| Porting Identification Type must be either DOB or ACCT | An invalid value was detected in the portingidentificationtype field. Please populate with the one of the values specified in the error message. |
| Porting Identification Type must be DOB For PREPAID porting type | Where the portingtype field was populated with PREPAID, the portingidentificationtype must be set to DOB. You cannot provide an account number for prepaid services. |
| Porting Identification cannot be blank for CHURN order | You must provide porting identification if the transfertype is CHURN. For prepaid this will be a the date of birth. For postpaid it can be date of birth or an account number. |
| Invalid format for Date of Birth | It is likely you have entered a value in the portingidentification field that is not in a standard date format. |
| DOB detects the age is below 18 years. | People under the age of 18 years are not permitted to port numbers. |
| Date of Birth must be in the past | As the message suggests, a date of birth cannot be in the past. |
| Porting Identification for type ACCT must consist of numbers only | You have entered a value in the portingidentification field that is not an inteteger where portingidentificationtype was set to 'ACCT'. |