API Overview Resources Schemas

Schemas

ContractSet

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "contracts": [
    {
      "url_expiration_date": "2023-01-27T03:44:52.000Z",
      "public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
      "media_type": "application/pdf",
      "name": "my_doc_name",
      "type": "ONLYMOBILE",
      "status": "SIGNATURE EXPIRED",
      "created_date": "2023-01-27T03:44:52.000Z",
      "contract_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
    }
  ]
}

Name	Type	Required	Description
contracts	[Contract]	false	none

Contract

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "url_expiration_date": "2023-01-27T03:44:52.000Z",
  "public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
  "media_type": "application/pdf",
  "name": "my_doc_name",
  "type": "ONLYMOBILE",
  "status": "SIGNATURE EXPIRED",
  "created_date": "2023-01-27T03:44:52.000Z",
  "contract_id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39"
}

Name	Type	Required	Description
url_expiration_date	string(date-time)	true	Expiration date for the supplied link. Format according to ISO 8601
public_url	string	true	Link to download the contract
media_type	string	true	Type of the provided file
name	string	false	Name of the document
type	string	true	Type of contract
status	string	true	Status of the contract
created_date	string(date-time)	true	Creation date. Format according to ISO 8601
contract_id	string	true	Contract unique identifier

GetSubscriptionShippings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


[
  {
    "account_id": 1233094,
    "created_date": "2017-09-15T22:00:00Z",
    "requested_date": "2017-09-15T22:00:00Z",
    "shipping_date": "2017-09-15T22:00:00Z",
    "item_number": 9806253,
    "account_expedition_id": 1233094,
    "logistics_id": 1233094,
    "status": "CONFIRMED",
    "address": "Carrer del Parc, 4-8, El Pont de Suert, Lleida, 25520",
    "applicable_cost": {
      "amount": 1,
      "type": "PAY_ON_DELIVERY"
    },
    "product_type": "SIM",
    "msisdn": 612121212,
    "first_name": "test",
    "last_name": "test",
    "document_number": "Y4444444",
    "email": "test@test",
    "terminal_name": "terminal name",
    "terminal_model": "16 blue 256GB"
  }
]

Name	Type	Required	Description
anonymous	[GetSubscriptionShipping]	false	none

GetSubscriptionShipping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "account_id": 1233094,
  "created_date": "2017-09-15T22:00:00Z",
  "requested_date": "2017-09-15T22:00:00Z",
  "shipping_date": "2017-09-15T22:00:00Z",
  "item_number": 9806253,
  "account_expedition_id": 1233094,
  "logistics_id": 1233094,
  "status": "CONFIRMED",
  "address": "Carrer del Parc, 4-8, El Pont de Suert, Lleida, 25520",
  "applicable_cost": {
    "amount": 1,
    "type": "PAY_ON_DELIVERY"
  },
  "product_type": "SIM",
  "msisdn": 612121212,
  "first_name": "test",
  "last_name": "test",
  "document_number": "Y4444444",
  "email": "test@test",
  "terminal_name": "terminal name",
  "terminal_model": "16 blue 256GB"
}

Name	Type	Required	Description
account_id	integer(int32)	false	internal unique identifier of the billable account the account bundle belongs to
created_date	string(date-time)	false	created date
requested_date	string(date-time)	false	requested date
shipping_date	string(date)	false	shipping date
item_number	integer(int32)	false	none
account_expedition_id	integer(int32)	false	internal unique identifier of the account expedition
logistics_id	string	false	internal unique identifier of the logistic
status	string	false	subscription shipping status
address	string	false	address > $address + $city + $state + $zipcode
applicable_cost	ApplicableCost	false	none
product_type	string	false	product type
msisdn	string	false	Reserved sim through devices-api in previous call
first_name	string	false	user name performing the operation
last_name	string	false	user last name performing the operation
document_number	string	false	user document number performing the operation
email	string	false	user email performing the operation
terminal_name	string	false	name of the corresponding terminal
terminal_model	string	false	name of the terminal model

ApplicableCost

1
2
3
4


{
  "amount": 1,
  "type": "PAY_ON_DELIVERY"
}

Name	Type	Required	Description
amount	number(double)	false	amount
type	string	false	Cost type

Property	Values
type	one of [PAY_ON_DELIVERY, PAID_IN_ADVANCE]

GetAccountBundle

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "id": 1233094,
  "account_id": 1233094,
  "status": "ACTIVE",
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "cancellation_date": "2017-09-15T22:00:00Z",
  "bundle_id": 3072,
  "bundled_subscriptions": [
    {
      "id": 1233094,
      "subscription_id": 3821002,
      "status": "ACTIVE",
      "subscription_type": "MOBILE",
      "commercial_product_id": 3073,
      "creation_date": "2017-09-15T22:00:00Z",
      "deactivation_date": "2017-09-15T22:00:00Z",
      "is_main": true
    }
  ]
}

Name	Type	Required	Description
anonymous	AccountBundle	false	none

Name	Type	Required	Description
anonymous	object	false	none

AccountBundle

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "id": 1233094,
  "account_id": 1233094,
  "status": "ACTIVE",
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "cancellation_date": "2017-09-15T22:00:00Z",
  "bundle_id": 3072,
  "bundled_subscriptions": [
    {
      "id": 1233094,
      "subscription_id": 3821002,
      "status": "ACTIVE",
      "subscription_type": "MOBILE",
      "commercial_product_id": 3073,
      "creation_date": "2017-09-15T22:00:00Z",
      "deactivation_date": "2017-09-15T22:00:00Z",
      "is_main": true
    }
  ]
}

Name	Type	Required	Description
id	string	false	Internal CRM unique account bundle identifier
account_id	string	false	internal unique identifier of the billable account the account bundle belongs to
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE
activation_date	string(date-time)	false	activation date (Mysim ActivateDate)
deactivation_date	string(date-time)	false	deactivation date (Mysim EndDate)
cancellation_date	string(date-time)	false	deactivation date (Mysim EndDate for deactivated subscriptions which have not been activated)
bundle_id	string	false	catalogue bundle id (Mysim accountBundleCfgId)
bundled_subscriptions	[BundledSubscription]	false	none

AccountBundleToMigrate

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "new_bundle_id": 1234,
  "bundled_subscriptions": [
    {
      "id": 1233094,
      "subscription_id": 3821002,
      "current_commercial_product_id": 3073,
      "new_commercial_product_id": 3074,
      "is_main": true,
      "executed_by_third_party": false
    }
  ],
  "user_name": "test@test",
  "account_id": "12345"
}

Name	Type	Required	Description
new_bundle_id	string	true	New bundle id
bundled_subscriptions	[BundledSubscriptionToMigrate]	true	array of addresses associated to the subscription
user_name	string	false	user name performing the operation (to be used for mysim users not authenticated through AuthN)
account_id	string	true	account id

BundledSubscriptionToMigrate

1
2
3
4
5
6
7
8


{
  "id": 1233094,
  "subscription_id": 3821002,
  "current_commercial_product_id": 3073,
  "new_commercial_product_id": 3074,
  "is_main": true,
  "executed_by_third_party": false
}

Name	Type	Required	Description
id	string	true	Internal CRM unique bundled subscription identifier
subscription_id	string	true	internal subscription id
current_commercial_product_id	string	true	current commercial product id
new_commercial_product_id	string	false	new commercial product id, null for those subscriptions without product change
is_main	boolean	true	indicates if the subscription is mandatory within the account bundle
executed_by_third_party	boolean	false	indicates if the product change has been already processed by the 3rd party service provider for the correspondent subscription

BundledSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": 1233094,
  "subscription_id": 3821002,
  "status": "ACTIVE",
  "subscription_type": "MOBILE",
  "commercial_product_id": 3073,
  "creation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "is_main": true
}

Name	Type	Required	Description
id	string	false	Internal CRM unique bundled subscription identifier
subscription_id	string	false	internal subscription id
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE
subscription_type	SubscriptionType	false	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE
commercial_product_id	string	false	commercial product id
creation_date	string(date-time)	false	activation date (Mysim CreatedDate)
deactivation_date	string(date-time)	false	deactivation date (Mysim EndDate)
is_main	boolean	false	none

SellMultiSimRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32


{
  "customer_id": 1234,
  "account_id": 10096875,
  "sale_details": {
    "date": "2017-09-15T22:00:00Z",
    "user_name": "test@test",
    "delivery_method": "OFFLINE",
    "scoring": {
      "id": "string",
      "value": "string"
    },
    "signature": {
      "id": "string",
      "type": "BIOMETRIC"
    }
  },
  "commercial_product_id": 1,
  "main_subscription_id": 5331402,
  "numeration_type": "NEW",
  "imsi": 214035453370793,
  "iccid": 8934011411551283000,
  "free_units_packages": [
    {
      "id": 1233094
    }
  ],
  "promotions": [
    {
      "id": 1233094
    }
  ]
}

Name	Type	Required	Description
customer_id	string	true	Customer identifier
account_id	string	true	account identifier
sale_details	object	true	none
» date	string(date-time)	true	sale date
» user_name	string	false	Optional user name
» delivery_method	string	true	Sale delivery method
» scoring	object	false	none
»» id	string	false	Sale scoring identifier
»» value	string	false	Sale scoring value
» signature	object	false	none
»» id	string	false	Sale signature identifier
»» type	string	false	Sale signature type
commercial_product_id	string	true	Commercial product identifier
main_subscription_id	string	true	Subscription identifier from an existent mobile subscription
numeration_type	NumerationType	true	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN
imsi	string	true	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	true	Circuit Card Identification Number associated to the SIM card
free_units_packages	[SellMultiSimRequestFreeUnitsPackage]	false	list of free units packages included in the sale
promotions	[SellMultiSimRequestPromotion]	false	list of promotions included in the sale

Property	Values
delivery_method	one of [OFFLINE, ONLINE]
type	one of [PAPER, BIOMETRIC, OTP]

SellMultiSimResponse

1
2
3


{
  "subscription_id": 3819912
}

Name	Type	Required	Description
subscription_id	string	false	subscription id created in the sale

DeactivateMultiSimRequest

1
2
3
4
5


{
  "deactivation_reason": "1234",
  "deactivation_user": "test@test.com",
  "requested_deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
deactivation_reason	string	true	Deactivation reason text or id as a string
deactivation_user	string	false	User that requests the deactivation
requested_deactivation_date	string(date-time)	false	deactivation date

SellDeviceInsuranceRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


{
  "customer_id": "1234",
  "account_id": "10096875",
  "sale_details": {
    "date": "2017-09-15T22:00:00Z",
    "user_name": "test@test",
    "delivery_method": "OFFLINE",
    "scoring": {
      "id": "string",
      "value": "string"
    },
    "signature": {
      "id": "string",
      "type": "BIOMETRIC"
    }
  },
  "commercial_product_id": 1,
  "subscription_id": "5331402",
  "subscription_device_id": "5331402",
  "promotions": [
    {
      "id": 1233094
    }
  ]
}

Name	Type	Required	Description
customer_id	string	true	Customer identifier
account_id	string	true	account identifier
sale_details	object	true	none
» date	string(date-time)	true	sale date
» user_name	string	false	Optional user name
» delivery_method	string	true	Sale delivery method
» scoring	object	false	none
»» id	string	false	Sale scoring identifier
»» value	string	false	Sale scoring value
» signature	object	false	none
»» id	string	false	Sale signature identifier
»» type	string	false	Sale signature type
commercial_product_id	string	true	Commercial product identifier
subscription_id	string	true	SubscriptionId associated to the SubscriptionDeviceId
subscription_device_id	string	true	SubscriptionDeviceId from insured device
promotions	[SellDeviceInsuranceRequestPromotion]	false	list of promotions included in the sale

Property	Values
delivery_method	one of [OFFLINE, ONLINE]
type	one of [PAPER, BIOMETRIC, OTP]

DeactivateDeviceInsuranceRequest

1
2
3
4
5


{
  "deactivation_reason": "BAJA VOLUNTARIA",
  "deactivation_user": "test@test.com",
  "requested_deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
deactivation_reason	string	true	Deactivation reason text or id as a string
deactivation_user	string	false	User that requests the deactivation
requested_deactivation_date	string(date-time)	false	deactivation date

DeactivateNetflixRequest

1
2
3
4
5


{
  "deactivation_reason": "BAJA VOLUNTARIA",
  "deactivation_user": "test@test.com",
  "requested_deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
deactivation_reason	string	true	Deactivation reason text or id as a string
deactivation_user	string	false	User that requests the deactivation
requested_deactivation_date	string(date-time)	false	deactivation date

AccountBundleMigrationResponse

1
2
3
4
5


{
  "message": "Order created correctly",
  "runId": "Order created correctly",
  "workflowId": "Order created correctly"
}

Name	Type	Required	Description
message	string	false	Result message
runId	string	false	Run id of the created workflow
workflowId	string	false	Workflow id of the created workflow

CancelDeviceInsuranceRequest

1
2
3
4
5


{
  "cancellation_reason": "BAJA VOLUNTARIA",
  "cancellation_user": "test@test.com",
  "requested_cancellation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
cancellation_reason	string	true	Cancellation reason text or id as a string
cancellation_user	string	false	User that requests the cancellation
requested_cancellation_date	string(date-time)	false	cancellation date

CancelActivationSubscriptionRequest

1
2
3
4
5


{
  "cancellation_reason": "BAJA VOLUNTARIA",
  "cancellation_user": "test@test.com",
  "requested_cancellation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
cancellation_reason	string	true	Cancellation reason text or id as a string
cancellation_user	string	false	User that requests the cancellation
requested_cancellation_date	string(date-time)	false	cancellation date

SellDeviceInsuranceResponse

1
2
3


{
  "subscription_id": 3819912
}

Name	Type	Required	Description
subscription_id	string	false	subscription id created in the sale

GetSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92


{
  "id": 1233094,
  "account_id": 1233094,
  "account_bundles": [
    {
      "account_bundle_id": 1233094,
      "status": "ACTIVE",
      "creation_date": "2017-09-15T22:00:00Z",
      "deactivation_date": "2017-09-15T22:00:00Z"
    }
  ],
  "sale_date": "2017-09-15T22:00:00Z",
  "sale_type": "SALE",
  "user_name": "test@test.com",
  "commercial_product_id": 3072,
  "billing_type": "POSTPAID",
  "subscription_type": "MOBILE",
  "subscription_additional_details": {
    "external_id": 11111111,
    "kit_type": "A-MAGNETICO",
    "kit_type_description": "CONTACTO MAGNETICO PARA PUERTAS",
    "third_party_address": {
      "address_type": "INSTALLATION",
      "address_lines": [
        {
          "address_line_name": "Street",
          "address_line_value": "Street name"
        }
      ],
      "contact_details": {
        "contact_name": "string",
        "contact_phone_1": "string",
        "contact_phone_2": "string",
        "contact_email_address": "string",
        "contact_identity_document": "string",
        "additional_details": "string"
      }
    },
    "third_party_work_order_status": "INSTALACION TERMINADA",
    "third_party_installation_status": "INSTALACION TERMINADA",
    "third_party_contract_status": "ACTIVO",
    "installation_date": "2017-09-15",
    "nxt_invoice_cfee_netamo": 8.264463,
    "nxt_invoice_ofee_netamo": 8.264463,
    "total_stay_time": 24,
    "stay_period": 24,
    "total_stay_cost": 400,
    "stay_cost": 400,
    "no_return_cost": 400,
    "install_comp": [
      {
        "item_cd": "A-MAGNETICO",
        "item_desc": "CONTACTO MAGNETICO PARA PUERTAS",
        "item_quantity": 1
      }
    ]
  },
  "addresses": [
    {
      "address_type": "INSTALLATION",
      "address_lines": [
        {
          "address_line_name": "Street",
          "address_line_value": "Street name"
        }
      ],
      "contact_details": {
        "contact_name": "string",
        "contact_phone_1": "string",
        "contact_phone_2": "string",
        "contact_email_address": "string",
        "contact_identity_document": "string",
        "additional_details": "string"
      }
    }
  ],
  "current_status": "ACTIVE",
  "current_status_date": "2017-09-15T22:00:00Z",
  "cancellation_reason": {
    "deactive_motive": "CANCELACION VENTA",
    "reason": "SUBSCRIPTION_NOT_ACTIVATED_AFTER_WAITING_TIME"
  },
  "status_history": [
    {
      "status_date": "2017-09-15T22:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "contract_documents": [
    "string"
  ]
}

Name	Type	Required	Description
anonymous	Subscription	false	none

Name	Type	Required	Description
anonymous	object	false	none

Subscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92


{
  "id": 1233094,
  "account_id": 1233094,
  "account_bundles": [
    {
      "account_bundle_id": 1233094,
      "status": "ACTIVE",
      "creation_date": "2017-09-15T22:00:00Z",
      "deactivation_date": "2017-09-15T22:00:00Z"
    }
  ],
  "sale_date": "2017-09-15T22:00:00Z",
  "sale_type": "SALE",
  "user_name": "test@test.com",
  "commercial_product_id": 3072,
  "billing_type": "POSTPAID",
  "subscription_type": "MOBILE",
  "subscription_additional_details": {
    "external_id": 11111111,
    "kit_type": "A-MAGNETICO",
    "kit_type_description": "CONTACTO MAGNETICO PARA PUERTAS",
    "third_party_address": {
      "address_type": "INSTALLATION",
      "address_lines": [
        {
          "address_line_name": "Street",
          "address_line_value": "Street name"
        }
      ],
      "contact_details": {
        "contact_name": "string",
        "contact_phone_1": "string",
        "contact_phone_2": "string",
        "contact_email_address": "string",
        "contact_identity_document": "string",
        "additional_details": "string"
      }
    },
    "third_party_work_order_status": "INSTALACION TERMINADA",
    "third_party_installation_status": "INSTALACION TERMINADA",
    "third_party_contract_status": "ACTIVO",
    "installation_date": "2017-09-15",
    "nxt_invoice_cfee_netamo": 8.264463,
    "nxt_invoice_ofee_netamo": 8.264463,
    "total_stay_time": 24,
    "stay_period": 24,
    "total_stay_cost": 400,
    "stay_cost": 400,
    "no_return_cost": 400,
    "install_comp": [
      {
        "item_cd": "A-MAGNETICO",
        "item_desc": "CONTACTO MAGNETICO PARA PUERTAS",
        "item_quantity": 1
      }
    ]
  },
  "addresses": [
    {
      "address_type": "INSTALLATION",
      "address_lines": [
        {
          "address_line_name": "Street",
          "address_line_value": "Street name"
        }
      ],
      "contact_details": {
        "contact_name": "string",
        "contact_phone_1": "string",
        "contact_phone_2": "string",
        "contact_email_address": "string",
        "contact_identity_document": "string",
        "additional_details": "string"
      }
    }
  ],
  "current_status": "ACTIVE",
  "current_status_date": "2017-09-15T22:00:00Z",
  "cancellation_reason": {
    "deactive_motive": "CANCELACION VENTA",
    "reason": "SUBSCRIPTION_NOT_ACTIVATED_AFTER_WAITING_TIME"
  },
  "status_history": [
    {
      "status_date": "2017-09-15T22:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "contract_documents": [
    "string"
  ]
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription identifier
account_id	string	false	internal unique identifier of the billable account the subscripton belongs to
account_bundles	[SubsAccountBundle]	false	array of account bundles the subscription has been associated to
sale_date	string(date-time)	false	sale date
sale_type	string	false	subscription sale type
user_name	string	false	user name of the user performing the subscription operation
commercial_product_id	string	false	unique identifier of the commercial product associated to the subscription
billing_type	string	false	billing type name
subscription_type	SubscriptionType	false	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE
subscription_additional_details	DetailedSubscription	false	none
addresses	[Address]	false	array of addresses associated to the subscription
current_status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE
current_status_date	string(date-time)	false	pre-activation date
cancellation_reason	object	false	cancellation reason
» deactive_motive	string	false	deactive motive from apollo
» reason	string	false	reason why subscription was cancelled or deactivated
status_history	[StatusChange]	false	array of status changes associated to the subscription
contract_documents	[string]	false	array of contract document’s ids related to the subscription

Property	Values
sale_type	one of [SALE, ADDSUBSCRIPTIONTOBUNDLE, MIGRATION]
billing_type	one of [POSTPAID, PREPAID]

SubsAccountBundle

1
2
3
4
5
6


{
  "account_bundle_id": 1233094,
  "status": "ACTIVE",
  "creation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
account_bundle_id	string	false	Internal CRM unique account bundle identifier
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE
creation_date	string(date-time)	false	activation date (Mysim CreatedDate)
deactivation_date	string(date-time)	false	deactivation date (Mysim EndDate)

StatusChange

1
2
3
4


{
  "status_date": "2017-09-15T22:00:00Z",
  "status": "ACTIVE"
}

Name	Type	Required	Description
status_date	string(date-time)	true	pre-activation date
status	SubscriptionStatus	true	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE

SecuritySubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


{
  "external_id": 11111111,
  "kit_type": "A-MAGNETICO",
  "kit_type_description": "CONTACTO MAGNETICO PARA PUERTAS",
  "third_party_address": {
    "address_type": "INSTALLATION",
    "address_lines": [
      {
        "address_line_name": "Street",
        "address_line_value": "Street name"
      }
    ],
    "contact_details": {
      "contact_name": "string",
      "contact_phone_1": "string",
      "contact_phone_2": "string",
      "contact_email_address": "string",
      "contact_identity_document": "string",
      "additional_details": "string"
    }
  },
  "third_party_work_order_status": "INSTALACION TERMINADA",
  "third_party_installation_status": "INSTALACION TERMINADA",
  "third_party_contract_status": "ACTIVO",
  "installation_date": "2017-09-15",
  "nxt_invoice_cfee_netamo": 8.264463,
  "nxt_invoice_ofee_netamo": 8.264463,
  "total_stay_time": 24,
  "stay_period": 24,
  "total_stay_cost": 400,
  "stay_cost": 400,
  "no_return_cost": 400,
  "install_comp": [
    {
      "item_cd": "A-MAGNETICO",
      "item_desc": "CONTACTO MAGNETICO PARA PUERTAS",
      "item_quantity": 1
    }
  ]
}

Name	Type	Required	Description
external_id	string	false	Security subscription id
kit_type	string	false	type of the installed kit
kit_type_description	string	false	description of the installed kit
third_party_address	Address	false	none
third_party_work_order_status	string	false	work order status on 3rd party side
third_party_installation_status	string	false	installation status on 3rd party side
third_party_contract_status	string	false	contract status on 3rd party side
installation_date	string(date)	false	installation date
nxt_invoice_cfee_netamo	number(double)	false	none
nxt_invoice_ofee_netamo	number(double)	false	none
total_stay_time	number(int32)	false	none
stay_period	number(int32)	false	none
total_stay_cost	number(double)	false	none
stay_cost	number(double)	false	none
no_return_cost	number(double)	false	none
install_comp	[InstallComp]	false	none

TvSubscription

1
2
3
4
5
6


{
  "requires_install_tech_support": false,
  "is_tech_support_billable": false,
  "registration_email": "test1@test.com",
  "payer_identity_document": "11111111A"
}

Name	Type	Required	Description
requires_install_tech_support	boolean	false	Installation with technical support flag
is_tech_support_billable	boolean	false	Technical support billable flag
registration_email	string	false	Email associated to the Tv subscription
payer_identity_document	string	false	TV subscription payer identification number

DataSharingSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "data_sharing_free_units_packages": [
    {
      "id": 1234,
      "subscription_id": 1234,
      "start_date": "2017-09-15T22:00:00Z",
      "end_date": "2017-09-15T22:00:00Z"
    }
  ],
  "data_sharing_members": [
    {
      "subscription_id": 3821002,
      "start_date": "2017-09-15T22:00:00Z",
      "end_date": "2017-09-15T22:00:00Z"
    }
  ],
  "mandatory_units": 8.264463,
  "optional_one_time_units": 8.264463,
  "optional_recurring_units": 8.264463,
  "network_group_id": "masmovil1233094"
}

Name	Type	Required	Description
data_sharing_free_units_packages	[SharingFreeUnitsPackage]	false	none
data_sharing_members	[SubscriptionMember]	false	Data sharing subscription id members
mandatory_units	number(double)	false	Shared units coming from mandatory free units packages (tariff units)
optional_one_time_units	number(double)	false	Shared units coming from optional one time free units packages
optional_recurring_units	number(double)	false	Shared units coming from optional recurring free units packages
network_group_id	string	false	Network group id

MobileSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


{
  "msisdn": 666777999,
  "numeration_type": "NEW",
  "imsi": 214035453370793,
  "iccid": 8934011411551283000,
  "associated_multi_sim_subscriptions": [
    {
      "msisdn": 666777999,
      "numeration_type": "NEW",
      "imsi": 214035453370793,
      "iccid": 8934011411551283000,
      "subscription_id": 1233094,
      "status": "ACTIVE"
    }
  ],
  "associated_apple_watch_subscriptions": [
    {
      "msisdn": 666777999,
      "imsi": 214035453370793,
      "iccid": 2.140354533707932e+31,
      "subscription_id": 1233094,
      "status": "ACTIVE"
    }
  ]
}

Name	Type	Required	Description
msisdn	string	false	Mobile number associated to subscription
numeration_type	NumerationType	false	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN
imsi	string	false	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	false	Circuit Card Identification Number associated to the SIM card
associated_multi_sim_subscriptions	[AssociatedMultiSimSubscription]	false	MultiSim subscriptions associated to the Mobile subscription
associated_apple_watch_subscriptions	[AssociatedAppleWatchSubscription]	false	Apple Watch subscriptions associated to the Mobile subscription

LandlineSubscription

1
2
3
4
5


{
  "landline_number": 666777999,
  "numeration_type": "NEW",
  "technology": "ANALOG"
}

Name	Type	Required	Description
landline_number	string	false	Landline number associated to subscription
numeration_type	NumerationType	false	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN
technology	string	false	technology associated to the landline subscription. Mapping with Mysim model SubscriptionType = 3 -> ANALOG SubscriptionType = 4 -> DIGITAL

Property	Values
technology	one of [ANALOG, DIGITAL]

BroadbandSubscription

1
2
3
4
5
6
7
8


{
  "requires_install_tech_support": false,
  "is_tech_support_billable": false,
  "territory_owner": "FIBMM02",
  "broadband_technology": "ADSL",
  "access_reuse_in_activation": false,
  "access_reuse_in_deactivation": false
}

Name	Type	Required	Description
requires_install_tech_support	boolean	false	Installation with technical support flag
is_tech_support_billable	boolean	false	Technical support billable flag
territory_owner	string	false	territory owner associated to the broadband subscription. Obtained from the correspondent AccountBundle within Mysim
broadband_technology	string	false	technology associated to the broadband subscription. Mapping with Mysim model SubscriptionType = 5 -> ADSL SubscriptionType = 6 -> FTTH
access_reuse_in_activation	boolean	false	notifies when a subscription is reusing a previous access from another client
access_reuse_in_deactivation	boolean	false	notifies when an access is being reused by another next client after the deactivation of the subscription

Property	Values
broadband_technology	one of [ADSL, FTTH]

MultiSimSubscription

1
2
3
4
5
6
7


{
  "msisdn": 666777999,
  "numeration_type": "NEW",
  "imsi": 214035453370793,
  "iccid": 8934011411551283000,
  "mainSubscriptionId": 1233094
}

Name	Type	Required	Description
msisdn	string	false	Mobile number associated to subscription
numeration_type	NumerationType	false	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN
imsi	string	false	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	false	Circuit Card Identification Number associated to the SIM card
mainSubscriptionId	string	true	Internal CRM unique subscription identifier

AppleWatchSubscription

1
2
3
4
5
6


{
  "msisdn": 666777999,
  "imsi": 214035453370793,
  "iccid": 2.140354533707932e+31,
  "mainSubscriptionId": 1233094
}

Name	Type	Required	Description
msisdn	string	false	Mobile number associated to subscription
imsi	string	false	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	false	ICCID stands for Integrated Circuit Card Identifier. It is a serial number corresponding to the SIM card installed in a connected device
mainSubscriptionId	string	true	Internal CRM unique subscription identifier

TerminateSubscriptionStatusRequest

1
2
3
4
5


{
  "status_change_user": "test@test.com",
  "status_change_reason": "customer request",
  "requested_status_change_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
status_change_user	string	true	user name of the user performing the subscription status change (Mysim user login)
status_change_reason	string	true	subscription status change reason
requested_status_change_date	string(date-time)	false	date when the status change must be effective

AssociatedMultiSimSubscription

1
2
3
4
5
6
7
8


{
  "msisdn": 666777999,
  "numeration_type": "NEW",
  "imsi": 214035453370793,
  "iccid": 8934011411551283000,
  "subscription_id": 1233094,
  "status": "ACTIVE"
}

Name	Type	Required	Description
msisdn	string	false	Mobile number associated to subscription
numeration_type	NumerationType	false	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN
imsi	string	false	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	false	Circuit Card Identification Number associated to the SIM card
subscription_id	string	false	Internal CRM unique subscription identifier
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE

AssociatedAppleWatchSubscription

1
2
3
4
5
6
7


{
  "msisdn": 666777999,
  "imsi": 214035453370793,
  "iccid": 2.140354533707932e+31,
  "subscription_id": 1233094,
  "status": "ACTIVE"
}

Name	Type	Required	Description
msisdn	string	false	Mobile number associated to subscription
imsi	string	false	International Mobile Subscriber Identity associated to the mobile subscription
iccid	string	false	ICCID stands for Integrated Circuit Card Identifier. It is a serial number corresponding to the SIM card installed in a connected device
subscription_id	string	false	Internal CRM unique subscription identifier
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE

DeviceInsuranceSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "subscription_device_id": 7367286,
  "request_id": 7367286,
  "insurance_policy_id": 7367286,
  "insurance_monthly_fee": 8.264463,
  "insurance_annual_fee": 8.264463,
  "deductible_included": false,
  "deductible_fee": 8.264463,
  "theft_included": false,
  "serial_number": false,
  "brand": false,
  "model": false
}

Name	Type	Required	Description
subscription_device_id	string	true	Id of the subscription device associated to the insurance
request_id	string	false	Id of the device insurance policy request, assigned by BIBE
insurance_policy_id	string	false	Id of the device insurance policy, assigned by BIBE
insurance_monthly_fee	number(double)	false	Insurance monthly fee
insurance_annual_fee	number(double)	false	Insurance annual fee
deductible_included	boolean	false	Indicates if the insurance policy includes a deductible amount
deductible_fee	number(double)	false	Insurance deductible fee
theft_included	boolean	false	Indicates if the insurance policy includes theft coverage
serial_number	string	false	serial number
brand	string	false	brand of the insured device
model	string	false	model of the insured device

NetflixSubscription

1
2
3
4


{
  "external_id": 7367286,
  "email": "test@gmail.com"
}

Name	Type	Required	Description
external_id	string	false	PAI associated to the subscription
email	string	false	Email associated to the subsbcription (not known for now)

InstallComp

1
2
3
4
5


{
  "item_cd": "A-MAGNETICO",
  "item_desc": "CONTACTO MAGNETICO PARA PUERTAS",
  "item_quantity": 1
}

Name	Type	Required	Description
item_cd	string	false	installed component
item_desc	string	false	installed component description
item_quantity	number(int32)	false	number of units installed

Address

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "address_type": "INSTALLATION",
  "address_lines": [
    {
      "address_line_name": "Street",
      "address_line_value": "Street name"
    }
  ],
  "contact_details": {
    "contact_name": "string",
    "contact_phone_1": "string",
    "contact_phone_2": "string",
    "contact_email_address": "string",
    "contact_identity_document": "string",
    "additional_details": "string"
  }
}

Name	Type	Required	Description
address_type	string	false	Address type
address_lines	[AddressLine]	false	Address information detail
contact_details	AddressContact	false	none

Property	Values
address_type	one of [BILLING, INSTALLATION, CONTACT, SHIPMENT]

AddressContact

1
2
3
4
5
6
7
8


{
  "contact_name": "string",
  "contact_phone_1": "string",
  "contact_phone_2": "string",
  "contact_email_address": "string",
  "contact_identity_document": "string",
  "additional_details": "string"
}

Name	Type	Required	Description
contact_name	string	false	Address contact name
contact_phone_1	string	false	Address contact phone 1
contact_phone_2	string	false	Address contact phone 2
contact_email_address	string	false	Address contact email
contact_identity_document	string	false	Address contact identity document
additional_details	string	false	Address additional details

AddressLine

1
2
3
4


{
  "address_line_name": "Street",
  "address_line_value": "Street name"
}

Name	Type	Required	Description
address_line_name	string	false	Address line name
address_line_value	string	false	Address line value (i.e.stree name, number value…)

Property	Values
address_line_name	one of [Street, StreetType, Number, Bis, City, Gescal, District, Block, Stair, Floor, Letter, ZipCode, Province, State, Country, AddressId, IsUnoccupiedPair, additionalDetails]

PatchSubscription

1
2
3
4
5
6
7
8
9


{
  "subscription_type": "MOBILE",
  "status_change": {
    "status": "ACTIVE",
    "status_change_user": "test@test.com",
    "status_change_reason": "customer request",
    "requested_status_change_date": "2017-09-15T22:00:00Z"
  }
}

Name	Type	Required	Description
subscription_type	SubscriptionType	true	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE
status_change	PatchStatusChange	false	none

PatchStatusChange

1
2
3
4
5
6


{
  "status": "ACTIVE",
  "status_change_user": "test@test.com",
  "status_change_reason": "customer request",
  "requested_status_change_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
status	SubscriptionStatus	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE
status_change_user	string	false	user name of the user performing the subscription status change (Mysim user login)
status_change_reason	string	false	subscription status change reason
requested_status_change_date	string(date-time)	false	date when the status change must be effective

Terms

1
2
3
4
5
6
7
8


{
  "id": 1233094,
  "terms_id": 76,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z",
  "type": "PermanenceContract",
  "commitment_duration": 1
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription terms identifier (SubscriptionBindingPeriodId within Mysim)
terms_id	string	true	Catalogue unique terms identifier (BindingTypeId within Mysim)
start_date	string(date-time)	true	terms start date (Mysim StartDate)
end_date	string(date-time)	true	terms end date (Mysim EndDate)
type	string	true	PermanenceContract (contract used when a minimum permanency is set), ActivationCommitment (terms type used when service activation is committed. For instance, the installation cost is subsidized only in case the service is finally activated. If the order is cancelled before activating the service but after performing installation, the installation cost could be charged to the customer through an ActivationCommitment terms), ReturnCommitment (terms type used for enabling the commitment of returning a subsidized item after the service deactivation. For instance, when the service provider delivers a device to the customer that it is actually owned buy the service provider, the customer will be typically forced to return the transferred device after service deactivation. This term type is used for enabling this type of commitment)
commitment_duration	number(int32)	false	duration of a PermanenceContract in months

Property	Values
type	one of [PermanenceContract, ActivationCommitment, ReturnCommitment]

Value

1
2
3
4


{
  "value": 8.264463,
  "currency": "euro"
}

Name	Type	Required	Description
value	number(double)	true	none
currency	string	false	null for values associated to promotion with discountTYpe=percentage. euro for rest

BasicCreditLimit

1
2
3
4
5
6
7
8
9


{
  "subscription_id": 3821002,
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "user_name": "test@test.com",
  "change_reason": "customer request",
  "effective_date": "2017-09-15T22:00:00Z",
  "update_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
subscription_id	string	false	internal subscription id
credit_limit_id	string	false	credit limit id
credit_limit_value	number	false	credit limit value
user_name	string	false	user name of the user setting the subscription credit limit (Mysim user login)
change_reason	string	false	subscription credit limit change reason
effective_date	string(date-time)	false	date when the limit starts to be effective
update_date	string(date-time)	false	date when the limit value is set

Property	Values
credit_limit_id	one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT]

CreditLimit

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "subscription_id": 3821002,
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "user_name": "test@test.com",
  "change_reason": "customer request",
  "effective_date": "2017-09-15T22:00:00Z",
  "update_date": "2017-09-15T22:00:00Z",
  "historical_changes": [
    {
      "subscription_id": 3821002,
      "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
      "credit_limit_value": 87.264463,
      "user_name": "test@test.com",
      "change_reason": "customer request",
      "effective_date": "2017-09-15T22:00:00Z",
      "update_date": "2017-09-15T22:00:00Z"
    }
  ]
}

Name	Type	Required	Description
anonymous	BasicCreditLimit	false	none

Name	Type	Required	Description
anonymous	object	false	none
» historical_changes	[BasicCreditLimit]	false	Subscription credit limit historical changes

GetCreditLimit

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "subscription_id": 3821002,
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "user_name": "test@test.com",
  "change_reason": "customer request",
  "effective_date": "2017-09-15T22:00:00Z",
  "update_date": "2017-09-15T22:00:00Z",
  "historical_changes": [
    {
      "subscription_id": 3821002,
      "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
      "credit_limit_value": 87.264463,
      "user_name": "test@test.com",
      "change_reason": "customer request",
      "effective_date": "2017-09-15T22:00:00Z",
      "update_date": "2017-09-15T22:00:00Z"
    }
  ]
}

Name	Type	Required	Description
anonymous	CreditLimit	false	none

Name	Type	Required	Description
anonymous	object	false	none

DefaultCreditLimit

1
2
3
4
5
6
7
8
9


{
  "mobile_total": 3821002,
  "mobile_roaming_voice": 3821002,
  "mobile_premium": 3821002,
  "mobile_international_voice": 3821002,
  "landline_total": 3821002,
  "landline_premium": 3821002,
  "landline_international_voice": 3821002
}

Name	Type	Required	Description
mobile_total	number(double)	false	xxx
mobile_roaming_voice	number(double)	false	xxx
mobile_premium	number(double)	false	xxx
mobile_international_voice	number(double)	false	xxx
landline_total	number(double)	false	xxx
landline_premium	number(double)	false	xxx
landline_international_voice	number(double)	false	xxx

PostCreditLimits

1
2
3
4
5
6
7
8
9


{
  "credit_limits": [
    {
      "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
      "credit_limit_value": 87.264463,
      "user_name": "test@test.com"
    }
  ]
}

Name	Type	Required	Description
credit_limits	[PostCreditLimit]	true	none

PostCreditLimit

1
2
3
4
5


{
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "user_name": "test@test.com"
}

Name	Type	Required	Description
credit_limit_id	string	true	credit limit id
credit_limit_value	number	false	credit limit value. If not received, default value configured for tenant will be provisioned
user_name	string	true	user name of the user setting the subscription credit limit (Mysim user login)

Property	Values
credit_limit_id	one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT]

PostCreditLimitsResponse

1
2
3
4
5


{
  "credit_limit_id": "MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "effective_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
credit_limit_id	string	false	credit limit id
credit_limit_value	number	false	credit limit value. If not received, default value configured for tenant will be provisioned
effective_date	string(date-time)	false	date when the limit starts to be effective

Property	Values
credit_limit_id	one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT]

PatchCreditLimit

1
2
3
4
5
6


{
  "credit_limit_id": "MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT",
  "credit_limit_value": 87.264463,
  "change_user": "test@test.com",
  "change_reason": "customer request"
}

Name	Type	Required	Description
credit_limit_id	string	true	credit limit id
credit_limit_value	number	true	credit limit value
change_user	string	true	user name of the user changing the subscription credit limit (Mysim user login)
change_reason	string	false	subscription credit limit change reason

Property	Values
credit_limit_id	one of [MOBILE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, MOBILE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_TOTAL_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_PREMIUM_CREDIT_LIMIT, LANDLINE_SUBSCRIPTION_INTERNATIONAL_VOICE_CREDIT_LIMIT]

PatchCreditLimits

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "subscription_type": "MOBILE",
  "credit_limits": [
    {
      "credit_limit_id": "MOBILE_SUBSCRIPTION_ROAMING_VOICE_CREDIT_LIMIT",
      "credit_limit_value": 87.264463,
      "change_user": "test@test.com",
      "change_reason": "customer request"
    }
  ]
}

Name	Type	Required	Description
subscription_type	SubscriptionType	true	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE
credit_limits	[PatchCreditLimit]	true	none

ErrorMessage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "XXX_21201",
      "title": "TITLE_OF_THE_DOMAIN_ERROR",
      "ref": "https://developers.masstack.com/en/docs/apis_domain_doc_swagger/2/apioverview/#erro",
      "details": "string"
    }
  ]
}

Name	Type	Required	Description
errors	[ErrorMessageItem]	true	none

ErrorMessageItem

1
2
3
4
5
6


{
  "code": "XXX_21201",
  "title": "TITLE_OF_THE_DOMAIN_ERROR",
  "ref": "https://developers.masstack.com/en/docs/apis_domain_doc_swagger/2/apioverview/#erro",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	Error code having an entry in a domain dictionary
title	string	true	Title of the error, having an entry in a domain dictionary
ref	string	true	Location in the developer portal
details	string	true	Message and details of the error

DetailedSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


{
  "external_id": 11111111,
  "kit_type": "A-MAGNETICO",
  "kit_type_description": "CONTACTO MAGNETICO PARA PUERTAS",
  "third_party_address": {
    "address_type": "INSTALLATION",
    "address_lines": [
      {
        "address_line_name": "Street",
        "address_line_value": "Street name"
      }
    ],
    "contact_details": {
      "contact_name": "string",
      "contact_phone_1": "string",
      "contact_phone_2": "string",
      "contact_email_address": "string",
      "contact_identity_document": "string",
      "additional_details": "string"
    }
  },
  "third_party_work_order_status": "INSTALACION TERMINADA",
  "third_party_installation_status": "INSTALACION TERMINADA",
  "third_party_contract_status": "ACTIVO",
  "installation_date": "2017-09-15",
  "nxt_invoice_cfee_netamo": 8.264463,
  "nxt_invoice_ofee_netamo": 8.264463,
  "total_stay_time": 24,
  "stay_period": 24,
  "total_stay_cost": 400,
  "stay_cost": 400,
  "no_return_cost": 400,
  "install_comp": [
    {
      "item_cd": "A-MAGNETICO",
      "item_desc": "CONTACTO MAGNETICO PARA PUERTAS",
      "item_quantity": 1
    }
  ]
}

Name	Type	Required	Description
anonymous	SecuritySubscription	false	none

Name	Type	Required	Description
anonymous	TvSubscription	false	none

Name	Type	Required	Description
anonymous	DataSharingSubscription	false	none

Name	Type	Required	Description
anonymous	MobileSubscription	false	none

Name	Type	Required	Description
anonymous	BroadbandSubscription	false	none

Name	Type	Required	Description
anonymous	LandlineSubscription	false	none

Name	Type	Required	Description
anonymous	MultiSimSubscription	false	none

Name	Type	Required	Description
anonymous	AppleWatchSubscription	false	none

Name	Type	Required	Description
anonymous	DeviceInsuranceSubscription	false	none

Name	Type	Required	Description
anonymous	NetflixSubscription	false	none

FreeUnitsPackage

1
2
3
4
5
6
7


{
  "id": 1233094,
  "free_units_package_id": 76,
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com"
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription free units package identifier
free_units_package_id	string	false	Catalogue unique free units package identifier
activation_date	string(date-time)	false	free units package subsciption activation date (Mysim AssociationDate)
deactivation_date	string(date-time)	false	promotion deactivation date (Mysim EndDate)
user_name	string	false	user name of the user who adds the promotion

GetFreeUnitsPackage

1
2
3
4
5
6
7


{
  "id": 1233094,
  "free_units_package_id": 76,
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com"
}

Name	Type	Required	Description
anonymous	FreeUnitsPackage	false	none

Name	Type	Required	Description
anonymous	object	false	none

SellMultiSimRequestFreeUnitsPackage

1
2
3


{
  "id": 1233094
}

Name	Type	Required	Description
id	string	true	Internal CRM unique subscription free units package identifier

SubscriptionId

1
2
3


{
  "subscription_id": 3821002
}

Name	Type	Required	Description
subscription_id	string	false	internal subscription id

SharingFreeUnitsPackage

1
2
3
4
5
6


{
  "id": 1234,
  "subscription_id": 1234,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
id	string	false	sharing free units package id
subscription_id	string	false	sharing free units package subscription id
start_date	string(date-time)	false	start date
end_date	string(date-time)	false	end date

SubscriptionMember

1
2
3
4
5


{
  "subscription_id": 3821002,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
subscription_id	string	false	internal subscription id
start_date	string(date-time)	false	start of the membership
end_date	string(date-time)	false	end of the membership

GetFraudRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "id": 1233094,
  "sell_id": 76,
  "risk_decision": "A",
  "subscriptions": [
    {
      "subscription_id": 3821002,
      "subscription_type": "MOBILE"
    }
  ]
}

Name	Type	Required	Description
anonymous	FraudRequest	false	none

Name	Type	Required	Description
anonymous	object	false	none

FraudRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "id": 1233094,
  "sell_id": 76,
  "risk_decision": "A",
  "subscriptions": [
    {
      "subscription_id": 3821002,
      "subscription_type": "MOBILE"
    }
  ]
}

Name	Type	Required	Description
id	string	false	Internal unique fraud request id
sell_id	string	false	Internal unique sell id
risk_decision	string	true	fraud request risk decision X -> Doc required A -> OK D -> Cancelled R -> KO
subscriptions	[FraudRequestSubscription]	false	none

Property	Values
risk_decision	one of [A, X, D, R]

FraudRequestSubscription

1
2
3
4


{
  "subscription_id": 3821002,
  "subscription_type": "MOBILE"
}

Name	Type	Required	Description
subscription_id	string	false	internal subscription id
subscription_type	SubscriptionType	false	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE

PatchFraudRequest

1
2
3
4
5
6
7
8
9


{
  "risk_decision": "A",
  "risk_level": 3,
  "risk_codes": "IH:c(4)s(0)r()v(779)",
  "fraud_request_value": 165089515739815,
  "status_change_user": "test@test.com",
  "status_change_reason": "customer request",
  "requested_status_change_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
risk_decision	string	true	fraud request risk decision X -> Doc required A -> OK D -> Cancelled
risk_level	integer(int32)	true	Value from 0 to 10
risk_codes	string	false	risk codes
fraud_request_value	integer(int64)	false	unique response id
status_change_user	string	false	user name of the user performing the subscription status change (Mysim user login)
status_change_reason	string	false	subscription status change reason
requested_status_change_date	string(date-time)	false	date when the status change must be effective

Property	Values
risk_decision	one of [A, X, D]

GetSubscriptionSegments

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "segments": [
    {
      "segment_id": "SEGMENT_ID",
      "segment_value": "SEGMENT_VALUE",
      "user_name": "test@test.com",
      "change_reason": "customer request",
      "effective_date": "2017-09-15T22:00:00Z"
    }
  ]
}

Name	Type	Required	Description
segments	[GetSubscriptionSegment]	true	subscription segments

GetSubscriptionSegment

1
2
3
4
5
6
7


{
  "segment_id": "SEGMENT_ID",
  "segment_value": "SEGMENT_VALUE",
  "user_name": "test@test.com",
  "change_reason": "customer request",
  "effective_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
segment_id	string	false	Segment identifier
segment_value	string	false	Segment value
user_name	string	false	User name of the user changing the subscription segment (Mysim user login)
change_reason	string	false	Segment change reason
effective_date	string(date-time)	false	date when the segment starts to be effective

PostSegments

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "segments": [
    {
      "segment_id": "SEGMENT_ID",
      "segment_value": "SEGMENT_VALUE",
      "change_user": "test@test.com",
      "change_reason": "customer request"
    }
  ]
}

Name	Type	Required	Description
segments	[PostSegment]	true	none

PostSegment

1
2
3
4
5
6


{
  "segment_id": "SEGMENT_ID",
  "segment_value": "SEGMENT_VALUE",
  "change_user": "test@test.com",
  "change_reason": "customer request"
}

Name	Type	Required	Description
segment_id	string	true	Segment identifier
segment_value	string	true	Segment value
change_user	string	true	User name of the user changing the subscription segment (Mysim user login)
change_reason	string	false	Segment change reason

GetSubscriptionDevice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


{
  "id": 1233094,
  "device_id": "P045A1SNC",
  "category": "SIM",
  "status": "ACTIVO",
  "contract_document_id": "string",
  "device_additional_details": {
    "iccid": 8934011411551283000,
    "imsi": 214035453370793,
    "pin": 1234,
    "puk": 1234,
    "pin2": 1234,
    "puk2": 1234,
    "fabrication_type": "eSIM"
  },
  "subscription_device_change_requests": [
    {
      "status": "PROCESSED",
      "request_date": "2017-09-15T22:00:00Z",
      "user_name": "test@test.com",
      "change_reason": "sim lost",
      "contract_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "fabrication_type": "eSIM",
      "iccid": 8934011411551283000,
      "imsi": 214035453370793
    }
  ]
}

Name	Type	Required	Description
anonymous	SubscriptionDevice	false	none

Name	Type	Required	Description
anonymous	object	false	none

SubscriptionDevice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


{
  "id": 1233094,
  "device_id": "P045A1SNC",
  "category": "SIM",
  "status": "ACTIVO",
  "contract_document_id": "string",
  "device_additional_details": {
    "iccid": 8934011411551283000,
    "imsi": 214035453370793,
    "pin": 1234,
    "puk": 1234,
    "pin2": 1234,
    "puk2": 1234,
    "fabrication_type": "eSIM"
  },
  "subscription_device_change_requests": [
    {
      "status": "PROCESSED",
      "request_date": "2017-09-15T22:00:00Z",
      "user_name": "test@test.com",
      "change_reason": "sim lost",
      "contract_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "fabrication_type": "eSIM",
      "iccid": 8934011411551283000,
      "imsi": 214035453370793
    }
  ]
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription device identifier
device_id	string	false	Catalogue unique device identifier
category	string	false	device category
status	string	false	device status
contract_document_id	string	false	Contract Document unique identifier. It can be an id with uuid format that is associated to a document stored within MasDocuments or a legacy pdf file name
device_additional_details	DetailedDevice	false	none
subscription_device_change_requests	[SubscriptionDeviceChangeRequest]	false	array of requests associated to the subscription device

DetailedDevice

1
2
3
4
5
6
7
8
9


{
  "iccid": 8934011411551283000,
  "imsi": 214035453370793,
  "pin": 1234,
  "puk": 1234,
  "pin2": 1234,
  "puk2": 1234,
  "fabrication_type": "eSIM"
}

Name	Type	Required	Description
anonymous	SimDevice	false	none

Name	Type	Required	Description
anonymous	Device	false	none

SimDevice

1
2
3
4
5
6
7
8
9


{
  "iccid": 8934011411551283000,
  "imsi": 214035453370793,
  "pin": 1234,
  "puk": 1234,
  "pin2": 1234,
  "puk2": 1234,
  "fabrication_type": "eSIM"
}

Name	Type	Required	Description
iccid	string	false	Circuit Card Identification Number associated to the SIM card
imsi	string	false	International mobile subscriber identity
pin	string	false	Pin
puk	string	false	puk
pin2	string	false	Pin2
puk2	string	false	puk2
fabrication_type	string	false	fabrication type

Property	Values
fabrication_type	one of [SIM, MICROSIM, NANOSIM, eSIM]

Device

1
2
3
4
5
6


{
  "sale_date": "2017-09-15T22:00:00Z",
  "delivery_date": "2017-09-15T22:00:00Z",
  "serial_number": "string",
  "insured_amount": -1
}

Name	Type	Required	Description
sale_date	string(date-time)	true	none
delivery_date	string(date-time)	false	none
serial_number	string	false	none
insured_amount	number(double)	true	field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned

SimDeviceChangeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "status": "PROCESSED",
  "request_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com",
  "change_reason": "sim lost",
  "contract_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fabrication_type": "eSIM",
  "iccid": 8934011411551283000,
  "imsi": 214035453370793
}

Name	Type	Required	Description
status	string	false	change request status
request_date	string(date-time)	false	request date
user_name	string	false	user name of the user performing the subscription device request
change_reason	string	false	device change reason
contract_document_id	string	false	Contract Document unique identifier. It can be an id with uuid format that is associated to a document stored within MasDocuments or a legacy pdf file name
fabrication_type	string	false	fabrication type
iccid	string	false	Circuit Card Identification Number associated to the SIM card
imsi	string	false	International mobile subscriber identity

Property	Values
fabrication_type	one of [SIM, MICROSIM, NANOSIM, eSIM]

SubscriptionDeviceChangeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "status": "PROCESSED",
  "request_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com",
  "change_reason": "sim lost",
  "contract_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fabrication_type": "eSIM",
  "iccid": 8934011411551283000,
  "imsi": 214035453370793
}

None

PatchSubscriptionDevice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "category": "SIM",
  "user_name": "test@test.com",
  "change_reason": "sim lost",
  "subscription_device_change_request": {
    "fabrication_type": "eSIM",
    "signature_process_id": "string",
    "signature_type": "PAPER",
    "iccid": 8934011411551283000,
    "imsi": 214035453370793,
    "new_iccid": "8934011411551283145",
    "new_imsi": "214035453370793"
  }
}

Name	Type	Required	Description
category	string	true	device category
user_name	string	false	user name of the user performing the subscription device request. If there is a token in place generated with real user credentials, there is no need to send this value since it will be obtained using the token claims
change_reason	string	false	device change reason
subscription_device_change_request	PatchSubscriptionDeviceChangeRequest	true	none

PatchSimDeviceChangeRequest

1
2
3
4
5
6
7
8
9


{
  "fabrication_type": "eSIM",
  "signature_process_id": "string",
  "signature_type": "PAPER",
  "iccid": 8934011411551283000,
  "imsi": 214035453370793,
  "new_iccid": "8934011411551283145",
  "new_imsi": "214035453370793"
}

Name	Type	Required	Description
fabrication_type	string	true	fabrication type
signature_process_id	string	false	id of the signature process triggered by sales channel
signature_type	string	false	signature type
iccid	string	false	Circuit Card Identification Number associated to the SIM card
imsi	string	false	International mobile subscriber identity
new_iccid	string	false	Circuit Card Identification Number associated to the SIM card to change by actual
new_imsi	string	false	International mobile subscriber identity to change by actual

Property	Values
signature_type	one of [PAPER, BIOMETRIC, OTP]

PatchSubscriptionDeviceChangeRequest

1
2
3
4
5
6
7
8
9


{
  "fabrication_type": "eSIM",
  "signature_process_id": "string",
  "signature_type": "PAPER",
  "iccid": 8934011411551283000,
  "imsi": 214035453370793,
  "new_iccid": "8934011411551283145",
  "new_imsi": "214035453370793"
}

None

PostPromotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "id": 1233094,
  "promotion_id": 76,
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com",
  "value": {
    "value": 8.264463,
    "currency": "euro"
  },
  "terms": {
    "id": 1233094,
    "terms_id": 76,
    "start_date": "2017-09-15T22:00:00Z",
    "end_date": "2017-09-15T22:00:00Z",
    "type": "PermanenceContract",
    "commitment_duration": 1
  }
}

Name	Type	Required	Description
anonymous	Promotion	false	none

Name	Type	Required	Description
anonymous	object	false	none

SellMultiSimRequestPromotion

1
2
3


{
  "id": 1233094
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription promotion identifier

SellDeviceInsuranceRequestPromotion

1
2
3


{
  "id": 1233094
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription promotion identifier

PostPromotionResponse

1
2
3


{
  "id": 1233094
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription promotion identifier

Promotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "id": 1233094,
  "promotion_id": 76,
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com",
  "value": {
    "value": 8.264463,
    "currency": "euro"
  },
  "terms": {
    "id": 1233094,
    "terms_id": 76,
    "start_date": "2017-09-15T22:00:00Z",
    "end_date": "2017-09-15T22:00:00Z",
    "type": "PermanenceContract",
    "commitment_duration": 1
  }
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription promotion identifier
promotion_id	string	false	Catalogue unique promotion identifier
activation_date	string(date-time)	false	promotion activation date (Mysim AssociationDate)
deactivation_date	string(date-time)	false	promotion deactivation date (Mysim EndDate)
user_name	string	false	user name of the user who adds the promotion
value	PromotionValue	false	none
terms	PromotionTerms	false	none

PromotionTerms

1
2
3
4
5
6
7
8


{
  "id": 1233094,
  "terms_id": 76,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z",
  "type": "PermanenceContract",
  "commitment_duration": 1
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription terms identifier (SubscriptionBindingPeriodId within Mysim)
terms_id	string	true	Catalogue unique terms identifier (BindingTypeId within Mysim)
start_date	string(date-time)	true	terms start date (Mysim StartDate)
end_date	string(date-time)	true	terms end date (Mysim EndDate)
type	string	true	PermanenceContract (contract used when a minimum permanency is set), ActivationCommitment (terms type used when service activation is committed. For instance, the installation cost is subsidized only in case the service is finally activated. If the order is cancelled before activating the service but after performing installation, the installation cost could be charged to the customer through an ActivationCommitment terms), ReturnCommitment (terms type used for enabling the commitment of returning a subsidized item after the service deactivation. For instance, when the service provider delivers a device to the customer that it is actually owned buy the service provider, the customer will be typically forced to return the transferred device after service deactivation. This term type is used for enabling this type of commitment)
commitment_duration	number(int32)	false	duration of a PermanenceContract in months

Property	Values
type	one of [PermanenceContract, ActivationCommitment, ReturnCommitment]

PromotionValue

1
2
3
4


{
  "value": 8.264463,
  "currency": "euro"
}

Name	Type	Required	Description
value	number(double)	true	none
currency	string	false	null for values associated to promotion with discountTYpe=percentage. euro for rest

PostPromotionDeactivate

1
2
3
4
5


{
  "deactivation_date": "2017-09-15T22:00:00Z",
  "user_name": "test@test.com",
  "status_change_reason": "customer request"
}

Name	Type	Required	Description
deactivation_date	string(date-time)	true	promotion deactivation date (Mysim EndDate)
user_name	string	false	user name of the user who deactivates the promotion
status_change_reason	string	false	promotion status change reason

NumerationType

1

"NEW"

Name	Type	Required	Description
anonymous	string	false	numeration type name. Mapping between Mysim origin and MasSubscriptions numeration_type OriginId=1 -> Nuevo numero -> NEW Origin=2 -> Numero portado -> OUTER_PORTABILITY OriginId=10 -> Numero entre marcas -> INNER_PORTABILITY Others -> UNKNOWN -> UNKNOWN

Property	Values
anonymous	one of [NEW, OUTER_PORTABILITY, INNER_PORTABILITY, UNKNOWN]

SubscriptionStatus

1

"ACTIVE"

Name	Type	Required	Description
anonymous	string	false	subscription status.Mapping between Mysim and MasSubscriptions status INSTALADO (1) -> SALEINCOMPLETE, SALECOMPLETE, SALECREATED PRE-ACTIVADO (2) -> PRE-ACTIVE ACTIVO (3) -> ACTIVE BLOQUEO POR SALDO (4) -> ACTIVE (with services barred) TERMINADO (6) > DEACTIVATED, CANCELLED, SALEREJECTED BLOQUEO TEMPORAL (7) -> ACTIVE (with services barred) PENDIENTE TERMINACION (9) -> PENDINGDEACTIVATION BLOQUEO LIMITE CONSUMO (10) -> ACTIVE (with services barred) BLOQUEO POR IMPAGO (12) -> ACTIVE (with services barred) SUSPENSION PENDIENTE (39) -> ACTIVE RECONEXION PENDIENTE (40) -> ACTIVE (with services barred) PENDIENTE BLOQUEO TEMPORAL (50) -> ACTIVE

Property	Values
anonymous	one of [SALEINCOMPLETE, SALECOMPLETE, PRE-ACTIVE, ACTIVE, PENDINGDEACTIVATION, PENDINGCANCELLATION, DEACTIVATED, CANCELLED, SALEREJECTED, SALECREATED]

SubscriptionType

1

"MOBILE"

Name	Type	Required	Description
anonymous	string	false	subscription type name. Mapping between Mysim and MasSubscriptions subscription_type PRE-PAGO -> MOBILE POST-PAGO -> MOBILE INTERNET FTTH-> BROADBAND INTERNET ADSL -> BROADBAND FIJO ANALOGICO-> LANDLINE FIJO DIGITAL -> LANDLINE AGILE TV -> TV SECURITY -> SECURITY DATASHARING -> DATASHARING MULTISIM -> MULTISIM DEVICEINSURANCE -> DEVICEINSURANCE NETFLIX -> NETFLIX APPLEWATCH -> APPLEWATCH AMAZONPRIME -> AMAZONPRIME MAX -> MAX ORANGE TV -> ORANGETV ORANGE TV LIBRE -> ORANGETVLIBRE

Property	Values
anonymous	one of [MOBILE, BROADBAND, LANDLINE, TV, SECURITY, DATASHARING, MULTISIM, DEVICEINSURANCE, NETFLIX, APPLEWATCH, AMAZONPRIME, MAX, ORANGETV, ORANGETVLIBRE]

GetCommercialProductsHistory

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "commercial_product_history": [
    {
      "history_id": 637746,
      "commercial_product_id": 3072,
      "start_date": "2017-09-15T22:00:00Z",
      "end_date": "2017-09-15T22:00:00Z"
    }
  ]
}

Name	Type	Required	Description
commercial_product_history	[CommercialProduct]	false	Commercial Products historical changes

CommercialProduct

1
2
3
4
5
6


{
  "history_id": 637746,
  "commercial_product_id": 3072,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
history_id	string	false	unique identifier of the commercial product history record
commercial_product_id	string	false	unique identifier of the commercial product associated to the subscription
start_date	string(date-time)	false	start date
end_date	string(date-time)	false	end date

SellAppleWatchRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "main_subscription_id": "5331402",
  "commercial_product_id": "1",
  "imsi": "214035453370793",
  "iccid": "8934011411551283144",
  "sale_details": {
    "user_name": "test@test"
  },
  "free_units_packages": [
    {
      "id": "1233094"
    }
  ],
  "promotions": [
    {
      "id": "1233094"
    }
  ]
}

Name	Type	Required	Description
main_subscription_id	string	true	Subscription identifier from an existent mobile subscription
commercial_product_id	string	true	Commercial product identifier
imsi	string	true	International Mobile Subscriber Identity associated to the AppleWatch subscription
iccid	string	true	Circuit Card Identification Number associated to the SIM card
sale_details	object	false	none
» user_name	string	false	Optional user name
free_units_packages	[SellAppleWatchRequestFreeUnitsPackage]	false	list of free units packages included in the sale
promotions	[SellAppleWatchRequestPromotion]	false	list of promotions included in the sale

SellAppleWatchResponse

1
2
3


{
  "subscription_id": 3819912
}

Name	Type	Required	Description
subscription_id	string	false	subscription id created in the sale

SellAppleWatchRequestFreeUnitsPackage

1
2
3


{
  "id": "1233094"
}

Name	Type	Required	Description
id	string	true	Internal CRM unique subscription free units package identifier

SellAppleWatchRequestPromotion

1
2
3


{
  "id": "1233094"
}

Name	Type	Required	Description
id	string	false	Internal CRM unique subscription promotion identifier

AppleWatchDeactivateSubscriptionRequest

1
2
3
4
5


{
  "deactivation_reason": "1234",
  "deactivation_user": "test@test.com",
  "requested_deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
deactivation_reason	string	true	Deactivation reason text or id as a string
deactivation_user	string	false	User that requests the deactivation
requested_deactivation_date	string(date-time)	false	deactivation date