Base profiles and services

Get base profiles

Returns an array of base profiles related to a commercial product id. Includes network provisioning details for each base profile as well as details of the services provisioned in the connection process as part of the profile.

GET /orgs/{org_id}/commercial_products/{id}/base_profiles

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/base_profiles \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Base Profile	[BaseProfile]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of BaseProfile

Custom schema example

 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


[
  {
    "id": "71_COMPRODUCT",
    "name": "PERFIL FTTH 50MB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "network_id": "2",
    "network_provisioning_id": "MM_CERO_VC_600M",
    "service_class": "2900",
    "offer_id": "300030015",
    "charging_id": "300030015",
    "manual_renewal": false,
    "download_speed": "300",
    "internet_speed": "300",
    "upload_speed": "300",
    "services": [
      {
        "id": "2",
        "name": "BLOQUEO DE LLAMADAS ENTRANTES",
        "description": "BLOQUEO DE LLAMADAS ENTRANTES",
        "in_catalogue_since": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "network_code": "obi",
        "is_changeable": true,
        "activate_on_network_provisioning": true,
        "language": "ESPANOL",
        "speed": "300Mb",
        "available_networks": "RED YOIGO+ORANGE+TELEFÓNICA"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getBaseProfiles_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» services	[BaseProfile_services]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getBaseProfiles_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» services	[BaseProfile_services]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
code	string	false	none

Get a list of existing base profiles

GET /orgs/{org_id}/base_profiles

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/base_profiles \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	[getBaseProfiles_Response]
400	Bad Request	Bad request	string
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of getBaseProfiles_Response

Custom schema example

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


[
  {
    "id": "71_COMPRODUCT",
    "name": "PERFIL FTTH 50MB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "network_id": "2",
    "network_provisioning_id": "MM_CERO_VC_600M",
    "service_class": "2900",
    "offer_id": "300030015",
    "charging_id": "300030015",
    "manual_renewal": false,
    "download_speed": "300",
    "internet_speed": "300",
    "upload_speed": "300"
  }
]

Name	Type	Required	Description
id	string	false	none
name	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
network_id	string	false	network that can be used for provisioning the services encapsulated within the base profile
network_provisioning_id	string	false	id used for provisioning the commercial product within the correspondent network
service_class	string	false	additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1
offer_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
charging_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
manual_renewal	boolean	false	boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
download_speed	string	false	download speed for broadband base profiles, used for provisioning purpose
internet_speed	string	false	commercial speed to be shown to client, could be different than the down and upload provisioning speed
upload_speed	string	false	upload speed for broadband base profiles, used for provisioning purpose

400 - JsonObject

Custom schema example

1

"Bad Request"

Name	Type	Required	Description
id	string	false	none
name	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
network_id	string	false	network that can be used for provisioning the services encapsulated within the base profile
network_provisioning_id	string	false	id used for provisioning the commercial product within the correspondent network
service_class	string	false	additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1
offer_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
charging_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
manual_renewal	boolean	false	boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
download_speed	string	false	download speed for broadband base profiles, used for provisioning purpose
internet_speed	string	false	commercial speed to be shown to client, could be different than the down and upload provisioning speed
upload_speed	string	false	upload speed for broadband base profiles, used for provisioning purpose

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
id	string	false	none
name	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
network_id	string	false	network that can be used for provisioning the services encapsulated within the base profile
network_provisioning_id	string	false	id used for provisioning the commercial product within the correspondent network
service_class	string	false	additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1
offer_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
charging_id	string	false	additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
manual_renewal	boolean	false	boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1
download_speed	string	false	download speed for broadband base profiles, used for provisioning purpose
internet_speed	string	false	commercial speed to be shown to client, could be different than the down and upload provisioning speed
upload_speed	string	false	upload speed for broadband base profiles, used for provisioning purpose

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
code	string	false	none

Get a particular base profile

GET /orgs/{org_id}/base_profiles/{id}/services

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	base profile identifier

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/base_profiles/122_COMPRODUCT/services \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	OK	[BaseProfile_services]
400	Bad Request	Bad request	string
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of BaseProfile_services

Custom schema example

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


[
  {
    "id": "2",
    "name": "BLOQUEO DE LLAMADAS ENTRANTES",
    "description": "BLOQUEO DE LLAMADAS ENTRANTES",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "network_code": "obi",
    "is_changeable": true,
    "activate_on_network_provisioning": true,
    "language": "ESPANOL",
    "speed": "300Mb",
    "available_networks": "RED YOIGO+ORANGE+TELEFÓNICA"
  }
]

Name	Type	Required	Description
id	string	false	none
name	string	false	none
description	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
from	string(date-time)	false	none
to	string(date-time)	false	none
network_code	string	false	parameter used by network to identify the service
is_changeable	boolean	false	means if the surrent service status can be changed
activate_on_network_provisioning	boolean	false	indicates if the service is automatically activated when the technical profile is provisioned
language	string	false	characteristic used for serviceId = 2. Not used for other services
speed	string	false	characteristic used for serviceId = 16. Not used for other services
available_networks	string	false	characteristic used for serviceId = 30. Not used for other services

400 - JsonObject

Custom schema example

1

"Bad Request"

Name	Type	Required	Description
id	string	false	none
name	string	false	none
description	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
from	string(date-time)	false	none
to	string(date-time)	false	none
network_code	string	false	parameter used by network to identify the service
is_changeable	boolean	false	means if the surrent service status can be changed
activate_on_network_provisioning	boolean	false	indicates if the service is automatically activated when the technical profile is provisioned
language	string	false	characteristic used for serviceId = 2. Not used for other services
speed	string	false	characteristic used for serviceId = 16. Not used for other services
available_networks	string	false	characteristic used for serviceId = 30. Not used for other services

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
id	string	false	none
name	string	false	none
description	string	false	none
in_catalogue_since	string(date-time)	false	none
in_catalogue_until	string(date-time)	false	none
from	string(date-time)	false	none
to	string(date-time)	false	none
network_code	string	false	parameter used by network to identify the service
is_changeable	boolean	false	means if the surrent service status can be changed
activate_on_network_provisioning	boolean	false	indicates if the service is automatically activated when the technical profile is provisioned
language	string	false	characteristic used for serviceId = 2. Not used for other services
speed	string	false	characteristic used for serviceId = 16. Not used for other services
available_networks	string	false	characteristic used for serviceId = 30. Not used for other services

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
code	string	false	none