Provision API
V1
Errors
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | [Error] | false | none |
Error
-
Name | Type | Required | Description |
---|---|---|---|
code | string | false | none |
title | string | false | none |
ref | string | false | none |
details | string | false | none |
AmazonCancelSubscription
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
reason | AmazonCancelReason | true | Indicates the reason for cancellation. - BILLING_FAILED_RENEWAL: Customer did not meet financial obligations in time for the billing cycle. - CUSTOMER_ACCOUNT_CHANGE: Customer has changed their account the offer is attached to. - CUSTOMER_CLOSED_ACCOUNT: Customer closed their account with the mobile operator. - CUSTOMER_INELIGIBLE: Customer was found to be ineligible for the offer. - CUSTOMER_OPT_OUT: Customer cancelled the subscription. - CUSTOMER_PLAN_CHANGE: Customer changed their rate plan and is no longer eligible for their subscription. - MERCHANT_OPT_OUT: Cancellation originated by partner, which does not map to any of the other reasons. - RESELLER_OPT_OUT: Cancellation originated by telco, which does not map to any of the other reasons. - SUSPECTED_FRAUD: Suspected fraud. - TEST_BUNDLE: Bundle was created for pre-launch testing, but has become stuck in an invalid state, or no longer desired, after launch. |
AmazonCreateSubscription
-
Name | Type | Required | Description |
---|---|---|---|
billing_id | AmazonBillingID | true | Unique subscriber identifier. |
AmazonEmail | false | The primary email address preferred by the customer. | |
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
msisdn | AmazonMSISDN | false | MSISDN |
offer_code | AmazonOfferCode | true | Offer identifier provided by Amazon. |
product | AmazonProductID | true | Amazon product identifier. |
AmazonGenerateActivationUrl
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
validity_duration_minutes | AmazonActivationURLValidityDuration | false | Specifies the validity duration of the activation URL in minutes. If provided, the activation URL will be valid for the specified duration. If not provided, a default validity duration will be used. Value must be between 15 and 60 minutes. |
AmazonGenerateAccountRecoveryUrl
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
AmazonGenerateActivationURLResponse
-
Name | Type | Required | Description |
---|---|---|---|
expiry_date | AmazonActivationURLExpiryDate | false | Date when activation URL expires in ISO 8601 format. |
url | AmazonActivationURL | false | Activation URL. |
AmazonGetBundleDetailsResponse
-
Name | Type | Required | Description |
---|---|---|---|
id | AmazonBundleID | false | Unique activated bundle id that is used in all subsequent operations. |
state | AmazonBundleState | false | State of the already active entitlement (bundle). - ACTIVATED: Bundle was successfully validated and activated - CANCELLED: Bundle was cancelled either by user or mobile operator - FAILED: Bundle activation failed - SUSPENDED: Bundle was suspended |
product | AmazonProductID | false | Amazon product identifier. |
subscription_id | AmazonSubscriptionID | false | Subscription identifier. |
starts_at | AmazonBundleStartsAt | false | ISO 8601 formatted bundle validity start. |
AmazonResumeSubscription
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
AmazonSuspendSubscription
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
AmazonUpdateSubscription
-
Name | Type | Required | Description |
---|---|---|---|
external_id | AmazonExternalID | true | Identifier to associate an account in your system with an Amazon account. |
product | AmazonProductID | true | Amazon product identifier. |
AmazonActivationURL
-
AmazonActivationURLValidityDuration
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | integer(int32) | false | Specifies the validity duration of the activation URL in minutes. If provided, the activation URL will be valid for the specified duration. If not provided, a default validity duration will be used. Value must be between 15 and 60 minutes. |
AmazonBillingID
-
AmazonBundleID
-
AmazonBundleStartsAt
-
AmazonBundleState
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | State of the already active entitlement (bundle). - ACTIVATED: Bundle was successfully validated and activated - CANCELLED: Bundle was cancelled either by user or mobile operator - FAILED: Bundle activation failed - SUSPENDED: Bundle was suspended |
AmazonCancelReason
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Indicates the reason for cancellation. - BILLING_FAILED_RENEWAL: Customer did not meet financial obligations in time for the billing cycle. - CUSTOMER_ACCOUNT_CHANGE: Customer has changed their account the offer is attached to. - CUSTOMER_CLOSED_ACCOUNT: Customer closed their account with the mobile operator. - CUSTOMER_INELIGIBLE: Customer was found to be ineligible for the offer. - CUSTOMER_OPT_OUT: Customer cancelled the subscription. - CUSTOMER_PLAN_CHANGE: Customer changed their rate plan and is no longer eligible for their subscription. - MERCHANT_OPT_OUT: Cancellation originated by partner, which does not map to any of the other reasons. - RESELLER_OPT_OUT: Cancellation originated by telco, which does not map to any of the other reasons. - SUSPECTED_FRAUD: Suspected fraud. - TEST_BUNDLE: Bundle was created for pre-launch testing, but has become stuck in an invalid state, or no longer desired, after launch. |
AmazonEmail
-
AmazonActivationURLExpiryDate
-
AmazonExternalID
-
AmazonOfferCode
-
AmazonProductID
-
AmazonSubscriptionID
-
NetflixCreateSubscription
-
|
|
Name | Type | Required | Description |
---|---|---|---|
billing_event_id | NetflixBillingEventID | true | A reference for this transaction that can be used to track or reconcile this transaction, if needed in the future. Do not use a PAI value. Maximum size is 1024 bytes. |
bundle_id | NetflixBundleID | true | Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another. |
channel | NetflixChannel | true | This attribute identifies the channel that the customer uses to sign up for the Bundle. |
netflix_email | NetflixEmail | false | The primary email address preferred by the customer. Value has to be in standard email format. - Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle. - Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address. |
netflix_offer_id | NetflixOfferID | true | A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version. |
netflix_phone | NetflixPhone | false | The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber] |
partner_account_id | NetflixPartnerAccountId | true | Partner Account Identifier (PAI) to associate an account in your system with a Netflix account. |
partner_charge_country | NetflixPartnerChargeCountry | true | Two letter codes that conform to ISO 3166-1 |
preferred_language | NetflixPreferredLanguage | false | The language in which the customer prefers to be contacted by email or SMS. - Netflix will continue adding newer languages as and when they start supporting them. - If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default. |
NetflixCreateSubscriptionResponse
-
Name | Type | Required | Description |
---|---|---|---|
id | NetflixSubscriptionId | false | Subscription identifier. Corresponds to the Partner Account Identifier (PAI). |
NetflixCancelSubscription
-
Name | Type | Required | Description |
---|---|---|---|
cancel_event_id | NetflixCancelEventID | true | A reference for this change/transaction that can be used to track/reconcile with the trigger for this event, if any is needed in future. Max 1024 is bytes. |
reason | NetflixCancelReason | true | Indicates the reason for cancellation. |
NetflixGenerateUrl
-
Name | Type | Required | Description |
---|---|---|---|
channel | NetflixBundleActivationChannel | true | This attribute identifies the channel that the customer uses to activate the Bundle. |
partner_charge_country | NetflixPartnerChargeCountry | true | Two letter codes that conform to ISO 3166-1 |
promotion_id | NetflixPromotionID | false | PromotionID agreed upon with Netflix. This only applies to prepaid promotion integrations. |
token_error_url | NetflixTokenErrorURL | true | If a token is invalid, the customer cannot complete the bundle activation. In that case, Netflix will present a call to action where Netflix can redirect the user. You should provide the URL that corresponds with the correct page on your site where the user can restart the flow. |
type | NetflixTokenType | true | The token type indicates the purpose of the token and its intended usage. |
validity_duration_in_seconds | NetflixValidityDurationInSeconds | false | For ACCOUNT_RECOVERY token type only. This value can be up to 24 hours. The token expiration defaults to 12 hours if not provided. Please initiate the Token request once the customer has clicked on the call to action on your website and before you redirect the customer to Netflix. |
NetflixGenerateUrlResponse
-
Name | Type | Required | Description |
---|---|---|---|
expiry_date | NetflixTokenExpiryDate | false | Date when token expires in ISO 8601 format. |
token | NetflixToken | false | Token value is a unique identifier based on UUID |
requested_securitized_url | NetflixRequestedSecuritizedUrl | false | RequestedSecuritizedUrl use token value to reference a Netflix url |
NetflixFetchSubscriptionEventsResponse
-
|
|
Name | Type | Required | Description |
---|---|---|---|
events | [NetflixSubscriptionEvent] | false | List of zero or more Event objects that are relevant to the time period defined by startTimestamp and endTimestamp |
next_page_offset | integer(int32) | false | A value that is used to retrieve subsequent pages of events that have occurred during the time period defined by the request attributes startTimestamp and endTimestamp. This value must be used to set the offset attribute for subsequent requests while using the same startTimestamp and endTimestamp. |
NetflixUpdateSubscription
-
|
|
Name | Type | Required | Description |
---|---|---|---|
billing_event_id | NetflixBillingEventID | true | A reference for this transaction that can be used to track or reconcile this transaction, if needed in the future. Do not use a PAI value. Maximum size is 1024 bytes. |
bundle_id | NetflixBundleID | false | Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another. |
channel | NetflixChannel | false | This attribute identifies the channel that the customer uses to sign up for the Bundle. |
netflix_email | NetflixEmail | false | The primary email address preferred by the customer. Value has to be in standard email format. - Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle. - Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address. |
netflix_offer_id | NetflixOfferID | false | A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version. |
netflix_phone | NetflixPhone | false | The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber] |
partner_charge_country | NetflixPartnerChargeCountry | false | Two letter codes that conform to ISO 3166-1 |
preferred_language | NetflixPreferredLanguage | false | The language in which the customer prefers to be contacted by email or SMS. - Netflix will continue adding newer languages as and when they start supporting them. - If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default. |
NetflixSuspend
-
NetflixUnsuspend
-
NetflixBillingEventID
-
NetflixBundleActivationChannel
-
NetflixBundleID
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another. |
NetflixCancelEventID
-
NetflixCancelReason
-
NetflixChannel
-
NetflixEmail
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | The primary email address preferred by the customer. Value has to be in standard email format. - Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle. - Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address. |
NetflixOfferID
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version. |
NetflixPartnerAccountId
-
NetflixPartnerChargeCountry
-
NetflixPhone
-
NetflixPreferredLanguage
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | The language in which the customer prefers to be contacted by email or SMS. - Netflix will continue adding newer languages as and when they start supporting them. - If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default. |
NetflixPromotionID
-
NetflixSubscriptionEvent
-
|
|
Name | Type | Required | Description |
---|---|---|---|
bundle_id | NetflixBundleID | false | Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another. |
event_type | string | false | Type of subscription event. The value must match one of the predefined SubscriptionEventType values. Future releases may add new values without breaking backward compatibility. |
netflix_event_id | string | false | An ID that uniquely identifies an event. This ID can be used for deduplication. |
netflix_offer_id | NetflixOfferID | false | A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version. |
original_netflix_transaction_id | string | false | This field is dependent on the type of event: - For the BUNDLE_PLAN_CHANGE event type, this field represents the NetflixTransactionID associated with the change event when a customer updated their Netflix plan via Netflix. - For the BUNDLE_SUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request. - For the BUNDLE_UNSUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request. |
partner_account_id | NetflixPartnerAccountId | false | Partner Account Identifier (PAI) to associate an account in your system with a Netflix account. |
partner_reference_id | string | false | This field is dependent on the type of event: - For the BUNDLE_ENROLLMENT event type, this field represents the BillingEventID associated with the original Enroll API request that resulted in Netflix creating a new bundle for the customer. - For the BUNDLE_PLAN_CHANGE event type, this field represents the BillingEventID associated with the original Enroll API request that resulted in Netflix creating a new bundle for the customer. This applies when the plan change was initiated for and on-behalf of the customer via your website/CS. - For the BUNDLE_CANCELLATION event type, this field represents the CancelEventID associated with the original Cancel API request. - For the BUNDLE_SUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request. - For the BUNDLE_UNSUSPENSION event type, this field represents the SuspendEventID associated with the original Suspend API request. |
timestamp | integer(int64) | false | Represents the time (milliseconds since the UNIX epoch) at which the event occurred. |
NetflixSubscriptionEventType
-
NetflixSubscriptionId
-
NetflixToken
-
NetflixRequestedSecuritizedUrl
-
NetflixTokenErrorURL
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | If a token is invalid, the customer cannot complete the bundle activation. In that case, Netflix will present a call to action where Netflix can redirect the user. You should provide the URL that corresponds with the correct page on your site where the user can restart the flow. |
NetflixTokenExpiryDate
-
NetflixTokenType
-
NetflixValidityDurationInSeconds
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | integer(int32) | false | For ACCOUNT_RECOVERY token type only. This value can be up to 24 hours. The token expiration defaults to 12 hours if not provided. Please initiate the Token request once the customer has clicked on the call to action on your website and before you redirect the customer to Netflix. |
NetflixGetSubscriptionStatusResponse
-
Name | Type | Required | Description |
---|---|---|---|
has_partner_mop | boolean | false | none |
product_type | string | false | none |
subscription | NetflixSubscription | false | none |
bundle | NetflixBundle | false | none |
NetflixSubscription
-
Name | Type | Required | Description |
---|---|---|---|
plan | NetflixPlan | false | none |
NetflixPlan
-
NetflixBundle
-
HboCreateSubscription
-
Name | Type | Required | Description |
---|---|---|---|
service_id | HboServiceId | true | Service identifier in HBO. Corresponds to Subscription Id. |
external_id | HboExternalId | true | Partner user identifier in HBO. It’s the Id in CRM. |
country | HboCountry | true | Country code. ISO 3166-1 alpha-2 code. |
product_code | HboProductCode | true | Product code |
product_name | HboProductName | false | Product name |
product_start_date | HboProductStartDate | true | Product start date |
product_expire_date | HboProductExpireDate | false | Product expire date |
product_renew_date | HboProductRenewDate | false | Product renew date |
HboCreateSubscriptionResponse
-
HboCancelSubscription
-
Name | Type | Required | Description |
---|---|---|---|
external_id | HboExternalId | true | Partner user identifier in HBO. It’s the Id in CRM. |
reason | HboReason | true | Reason for the cancellation |
product_code | HboProductCode | true | Product code |
product_expire_date | HboProductExpireDate | false | Product expire date |
HboCancelSubscriptionResponse
-
HboGenerateActivationUrl
-
Name | Type | Required | Description |
---|---|---|---|
external_id | HboExternalId | true | Partner user identifier in HBO. It’s the Id in CRM. |
country | HboCountry | false | Country code. ISO 3166-1 alpha-2 code. |
product_code | HboProductCode | true | Product code |
product_name | HboProductName | false | Product name |
product_start_date | HboProductStartDate | true | Product start date |
product_expire_date | HboProductExpireDate | false | Product expire date |
product_renew_date | HboProductRenewDate | false | Product renew date |
transaction_id | HboTransactionId | false | ID of the transaction that granted the user access to the product. |
HboGenerateActivationURLResponse
-
Name | Type | Required | Description |
---|---|---|---|
url | HboActivationURL | false | Activation URL. |
WorkflowResponse
-
HboServiceId
-
HboExternalId
-
HboCountry
-
HboProductStartDate
-
HboProductExpireDate
-
HboProductRenewDate
-
HboReason
-
HboActivationURL
-
HboTransactionId
-
FtthOrangeAccessResponse
-
|
|
Name | Type | Required | Description |
---|---|---|---|
address | string | false | none |
brand | string | false | none |
cVlan | string | false | none |
code | string | false | none |
cto | string | false | none |
ctoAddress | string | false | none |
ctoLocation | string | false | none |
ctoPort | string | false | none |
ctoType | string | false | none |
derivationBoxCode | string | false | none |
derivationBoxLocation | string | false | none |
description | string | false | none |
deviceBrand | string | false | none |
deviceModel | string | false | none |
documentNumber | string | false | none |
documentType | string | false | none |
footprint | string | false | none |
gescal37 | string | false | none |
idAddressTo | string | false | none |
iptv | string | false | none |
iua | string | false | none |
iuaBillingWholesale | string | false | none |
lagAdministrative | string | false | none |
message | string | false | none |
modality | string | false | none |
oltCard | string | false | none |
oltCode | string | false | none |
oltModel | string | false | none |
oltPort | string | false | none |
ontId | string | false | none |
ontManufacturer | string | false | none |
ontPassword | string | false | none |
phoneNumber | string | false | none |
ppai | string | false | none |
sVlan | string | false | none |
splitterId | string | false | none |
splitterType | string | false | none |
tv | string | false | none |
verticalManager | string | false | none |
GetFtthAccesesInfoResponse
-
|
|
Name | Type | Required | Description |
---|---|---|---|
brand | string | false | none |
footprint | string | false | none |
phone_number | string | false | none |
document | string | false | none |
document_type | string | false | none |
iua | string | false | none |
gescal | string | false | none |
address | string | false | none |
tv | boolean | false | indicates wether its has service or not |
domicile_id | string | false | none |
cto | string | false | none |
cto_type | string | false | none |
cto_location | string | false | none |
cto_install_type | string | false | none |
splitter | string | false | none |
splitter_type | string | false | none |
cto_port | integer | false | none |
cd | string | false | none |
cd_type | string | false | none |
cd_location | string | false | none |
olt | string | false | none |
olt_type | string | false | none |
olt_sw_version | string | false | none |
olt_card | integer | false | none |
gpon_port | integer | false | none |
ont_id | integer | false | none |
tesa_ont_id | string | false | none |
ont_password | string | false | none |
ppai | string | false | none |
template | string | false | none |
remote_id | string | false | none |
remote_id_tv | string | false | none |
vertical_manager | string | false | none |
vlan | integer | false | none |
s_vlan | integer | false | none |
c_vlan | integer | false | none |
device_brand | string | false | none |
device_model | string | false | none |
fw_version | string | false | none |
serial_number | string | false | none |
device_identity | string | false | none |
iua_wholesaler_fact | string | false | none |
administrative_lag | string | false | none |
modality | string | false | none |
RetentionsRequest
-
|
|
Name | Type | Required | Description |
---|---|---|---|
reuseAccess | boolean | true | Reuse access |
source | object | false | none |
» gescal37 | string | false | Gescal37 of the source client. Mandatory if reuseAccess=“true” |
» iua | string | false | IUA of the source client. Mandatory if reuseAccess=“true” |
» phoneNumber | string | false | Phone number of the source client. Mandatory if reuseAccess=“true” |
» documentNumber | string | false | Document number of the source client. Mandatory if reuseAccess=“true” |
» clientName | string | false | Client name of the source client. Mandatory if reuseAccess=“true” |
» brand | string | false | Brand of the source client. Mandatory if reuseAccess=“true” |
destination | object | true | none |
» gescal37 | string | true | Gescal37 of the destination client |
» iua | string | false | IUA of the destination client |
» phoneNumber | string | false | Phone number of the destination client |
» documentNumber | string | false | Document number of the destination client |
» clientName | string | false | Client name of the destination client |
» brand | string | true | Brand of the destination client |
» bandwidth | string | true | Contracted speed |
» customerType | string | true | Segment of the destination client |
» tv | string | false | TV contracted of the destination brand. Allowed values: OTT,IPTV,IPTV+OTT |
RetentionsResponse
-
InsuranceCreationRequestDTO
-
|
|
Name | Type | Required | Description |
---|---|---|---|
documentId | string | false | none |
firstName | string | false | none |
lastName1 | string | false | none |
lastName2 | string | false | none |
msisdn | string | false | none |
address | string | false | none |
string | false | none | |
zipCode | string | false | none |
locality | string | false | none |
province | string | false | none |
language | string | false | none |
sfid | string | false | none |
telcoBrand | string | false | none |
brand | string | false | none |
model | string | false | none |
price | number | false | none |
clientType | string | false | none |
invoicePayment | boolean | false | none |
productType | string | false | none |
imei | string | false | none |
terminalSaleDate | string(date) | false | none |
entity | string | false | none |
officeCode | string | false | none |
dc | string | false | none |
accountNumber | string | false | none |
InsuranceCreationResponseDTO
-
|
|
Name | Type | Required | Description |
---|---|---|---|
requestId | string | false | none |
policyNumber | string | false | none |
monthlyFee | number | false | none |
annualFee | number | false | none |
franchise | boolean | false | none |
franchiseAmount | number | false | none |
theft | boolean | false | none |
monthlyNetFee | number | false | none |
annualNetFee | number | false | none |
annualLea | number | false | none |
monthlyLea | number | false | none |
annualIps | number | false | none |
monthlyIps | number | false | none |
annualConsortium | number | false | none |
monthlyConsortium | number | false | none |
firstAnnualLea | number | false | none |
firstMonthlyConsortium | number | false | none |
firstAnnualIps | number | false | none |
firstAnnualNetFee | number | false | none |
firstAnnualFee | number | false | none |
InsuranceIssueRequestDTO
-
Name | Type | Required | Description |
---|---|---|---|
requestId | string | false | none |
policyNumber | string | false | none |
imei | string | false | none |
msisdn | string | false | none |
document | string | false | none |
subscriptionId | string | false | none |
InsuranceIssueResponseDTO
-
Name | Type | Required | Description |
---|---|---|---|
requestId | string | false | none |
policyNumber | string | false | none |
monthlyFee | number | false | none |
annualFee | number | false | none |
franchise | boolean | false | none |
franchiseAmount | number | false | none |
theft | boolean | false | none |
InsuranceCancellationRequestDTO
-
InsuranceCancellationResponseDTO
-
InsuranceInfoResponseDTO
-
|
|
Name | Type | Required | Description |
---|---|---|---|
certificateNumber | string | false | none |
imei | string | false | none |
brand | NameDTO | false | none |
model | DescriptionDTO | false | none |
phoneNumber | string | false | none |
document | string | false | none |
firstName | string | false | none |
lastName1 | string | false | none |
lastName2 | string | false | none |
address | string | false | none |
number | string | false | none |
city | string | false | none |
zipCode | string | false | none |
policyNumber | string | false | none |
province | string | false | none |
effectiveDate | string(date) | false | none |
string | false | none | |
sold | boolean | false | none |
cancelled | boolean | false | none |
cancellationDate | string(date) | false | none |
serialNumber | string | false | none |
paymentMethod | DescriptionDTO | false | none |
clientType | NameDTO | false | none |
billPayment | boolean | false | none |
withdrawal | boolean | false | none |
withdrawalDate | string(date) | false | none |
emitted | boolean | false | none |
language | NameDTO | false | none |
accident | boolean | false | none |
DescriptionDTO
-
errorResponseDtoDeviceInsurance
-
errorResponseDto
-
ActivateSubscription
-
|
|
Name | Type | Required | Description |
---|---|---|---|
false | |||
firstName | FirstName | true | First Name |
lastName | LastName | true | Last name |
ftthWorkOrderId | FtthWorkOrderId | false | FTTH work order identifier |
maxStb | MaxStb | false | Max stb |
maxTerminals | MaxTerminals | true | Max terminals |
password | Password | false | password |
postalCode | PostalCode | false | Postal code |
segment | Segment | false | Segment |
phoneNumber | PhoneNumber | false | Phone number |
spId | SpId | true | Sp id |
spendingLimit | SpendingLimit | false | Spending limit |
customerType | CustomerType | true | Customer type |
servicePlan | ServicePlan | false | Service plan for creation without FTTH |
externalID | ExternalID | false | Identifier of the subscription on the CRM |
ftthServiceID | FtthServiceID | false | For north brands where we don’t have the order on wo_data, we use ftthServiceId. |
ModifySubscription
-
Name | Type | Required | Description |
---|---|---|---|
segment | Segment | false | Segment |
servicePlanToAdd | ServicePlanToAdd | true | Service type list to add |
servicePlanToDelete | ServicePlanToDelete | true | Service type list to delete |
ModifyCustomer
-
Name | Type | Required | Description |
---|---|---|---|
ftthWorkOrderId | FtthWorkOrderId | false | FTTH work order identifier |
password | Password | false | password |
parentalPin | ParentalPin | false | Parental PIN |
false | |||
postalCode | PostalCode | false | Postal code |
spendingLimit | SpendingLimit | false | Spending limit |
CancelSubscriptionRequest
-
GetDevicesResponse
-
Name | Type | Required | Description |
---|---|---|---|
anonymous | [Terminal] | false | none |
Terminal
-
Name | Type | Required | Description |
---|---|---|---|
macAddress | string | false | none |
name | string | false | none |
modelExternalId | string | false | none |
registrationDate | string | false | none |
serialNumber | string | false | none |
vua | string | false | none |
stbSn | string | false | none |
Segment
-
FtthWorkOrderId
-
ExternalID
-
FtthServiceID
-
TesaActivationRequest
-
|
|
Name | Type | Required | Description |
---|---|---|---|
territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
portabilityIndicator | string | false | Portability type: * D - Donor* T - Third party* N - Without portability* A - Agreement |
externalReference | string | true | none |
technicalCoordinators | TesaTechnicalCoordinators | true | none |
customer | TesaCustomer | true | none |
servicePoint | TesaServicePoint | true | none |
Property | Values |
---|---|
territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
portabilityIndicator | one of [D, T, N, A] |
TesaTechnicalCoordinators
-
Name | Type | Required | Description |
---|---|---|---|
name | string | true | none |
surnames | string | true | none |
phoneNumbers | TesaPhoneNumbers | true | none |
emails | TesaEmails | true | none |
fax | string | true | none |
TesaCustomer
-
Name | Type | Required | Description |
---|---|---|---|
name | string | true | none |
surnames | string | true | none |
segment | string | true | Territory owner: * B2C - Consumer* B2B - Business* B2B2C - Business to business to consumer |
phoneNumbers | TesaPhoneNumbers | true | none |
Property | Values |
---|---|
segment | one of [B2C, B2B, B2B2C] |
TesaServicePoint
-
|
|
Name | Type | Required | Description |
---|---|---|---|
gescal | string | false | none |
comments | string | false | none |
iua | string | false | none |
ppai | string | false | none |
opVlan | string | false | none |
speed | TesaSpeed | true | none |
installation | TesaInstallation | true | none |
maintenance | TesaMaintenance | true | none |
portability | TesaPortability | false | none |
TesaPhoneNumbers
-
TesaEmails
-
TesaSpeed
-
TesaMaintenance
-
TesaInstallation
-
TesaPortability
-
|
|
Name | Type | Required | Description |
---|---|---|---|
phoneNumber | string | false | none |
documentType | string | false | Document type: * L - CIF* D - DNI* R - NIE* P - Passport |
documentNumber | string | false | none |
accessType | string | false | Document type: * 01 - INDIVIDUAL* 03 - MULTIPLE |
nrn | string | false | none |
phoneRange | TesaPhoneRange | false | none |
wholeNumbering | boolean | false | none |
resellerDonor | TesaReseller | false | none |
resellerRecipient | TesaReseller | false | none |
Property | Values |
---|---|
documentType | one of [L, D, R, P] |
accessType | one of [01, 03] |
TesaPhoneRange
-
TesaReseller
-
TesaTerminationRequest
-
|
|
Name | Type | Required | Description |
---|---|---|---|
territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
externalReference | string | true | none |
technicalCoordinators | TesaTechnicalCoordinators | true | none |
customer | TesaCustomer | true | none |
servicePoint | TesaTerminationServicePoint | true | none |
Property | Values |
---|---|
territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
TesaTerminationServicePoint
-
TesaCancellationRequest
-
TesaIncidentResolveRequest
-
TesaCreateAccessRequest
-
TesaCreateAccessResult
-
TesaCreateStatusCtoRequest
-
TesaCreatePortRequest
-
TesaTerminateAccessRequest
-
TesaInstallationIncidentRequest
-
Name | Type | Required | Description |
---|---|---|---|
externalReference | string | true | none |
requestType | string | true | none |
requestNumber | integer(int64) | true | none |
subRequestNumber | integer(int64) | true | none |
incidence | string | true | none |
cto | string | true | none |
comments | string | true | none |
TesaInstallationEndRequest
-
Name | Type | Required | Description |
---|---|---|---|
externalReference | string | true | none |
requestType | string | true | none |
requestNumber | integer(int64) | true | none |
subRequestNumber | integer(int64) | true | none |
test | string | true | none |
indicator | string | true | none |
owner | string | true | none |
Property | Values |
---|---|
requestType | one of [NEBA, VULA] |
TesaCtoChangeRequest
-
Name | Type | Required | Description |
---|---|---|---|
externalReference | string | true | none |
ctoIdentifier | string | true | none |
ctoPort | string | false | none |
reason | TesaReasonForCtoChange | true | Reason for the CTO change: * AV - Broken* OT - Others |
TesaReasonForCtoChange
-
TesaStatus
-
TesaPersistenceType
-
TesaError
-
TesaRequest
-
|
|
Name | Type | Required | Description |
---|---|---|---|
reference_id | string | true | Operator id reference |
request_number | integer(int64) | false | Request code returned by TESA |
subrequest_number | integer(int64) | false | Subrequest code returned by TESA |
request_type | string | true | Request type e.g NEB101, NBL101 |
persistence_type | TesaPersistenceType | true | Persistence type: * ACTIVATION - Activation Request* TERMINATION - Termination Request |
territory_owner | string | true | Territory Owner identifier: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
tenant | string | true | Tenant in lower case |
portability | TesaPortability | false | none |
technical_coordinator | TesaTechnicalCoordinators | true | none |
customer_contact | TesaCustomerContact | true | none |
service_point | TesaServicePoint | true | none |
status | TesaStatus | true | none |
connection | TesaConnection | false | none |
connection_data | TesaConnectionData | false | none |
cancelling | boolean | false | Whether the request is being cancelled |
portability_indicator | string | false | Portability indicator: * D - Donor* T - Third party* N - Without portability* A - Agreement |
external_reference | string | true | External reference |
reject_cause | string | false | Reject cause |
close_date | string(date-time) | false | Close date |
create_date | string(date-time) | false | Create date |
update_date | string(date-time) | false | Update date |
Property | Values |
---|---|
territory_owner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
portability_indicator | one of [D, T, N, A] |
TesaEvent
-
Name | Type | Required | Description |
---|---|---|---|
id | integer(int64) | false | Event id |
reference_id | string | true | Request reference id |
message_type | string | true | TESA message type |
request_number | integer(int64) | true | TESA request code |
subrequest_number | integer(int64) | true | TESA subrequest code returned |
event_date | string(date-time) | true | Event date |
sequence_number | integer(int32) | true | Sequence Number |
inconsistent | boolean | true | If true, the event must be reconciled. |
TesaIssue
-
Name | Type | Required | Description |
---|---|---|---|
id | integer(int64) | true | Id of the issue |
reference_id | string | true | Request reference id |
issue_sequence | integer(int32) | true | Number of issue |
issue_code | string | true | Issue code |
resolved | boolean | true | Issue is resolved or not |
repeated | boolean | false | Issue is repeated or not |
last_updated | string(date-time) | true | The date of the issue |
TesaCustomerContact
-
Name | Type | Required | Description |
---|---|---|---|
name | string | true | Contact name |
surnames | string | true | Contact Surnames |
phone_number | string | true | Contact phone number |
phone_number_2 | string | true | Contact phone number 2 |
segment | string | true | Customer segment |
Property | Values |
---|---|
segment | one of [B2C, B2B, B2B2C] |
TesaConnection
-
Name | Type | Required | Description |
---|---|---|---|
connection_test | string | false | Connection test: * S - Final test OK* N - Final test not done or final test not OK |
connection_reuse_indicator | string | false | Connection reuse indicator: * S - Reuse* N - Not reuse |
connection_owner | string | false | Connection owner: * TE - TELEFÓNICA* OR - ORANGE / JAZZTEL* VD - VODAFONE / VODAFONE ONO* DI - DIGI* MM - MÁSMÓVIL / GRUPO MM* EU - EUSKALTEL / R-CABLE |
status | TesaConnectionStatus | true | none |
close_date | string(date-time) | false | Close date |
create_date | string(date-time) | false | Create date |
TesaConnectionData
-
|
|
Name | Type | Required | Description |
---|---|---|---|
iua | string | false | Unique access identifier |
province_code | string | false | Province code |
town | string | false | Town |
address | string | false | Town |
splitter_indicator | string | false | Splitter indicator: * S - There is a splitter* N - There is not a splitter |
splitter_location | string | false | Splitter location |
splitter_detail | string | false | Splitter detail |
cto_type | string | false | CTO type |
cto_location | string | false | CTO location |
cto_location_detail | string | false | CTO location detail |
cto_identifier | string | false | CTO identifier |
cto_port | integer(int32) | false | CTO port |