generic_provider_subscriptions_to_be_provisioned_short

 generic provider subscriptions to be provisioned response data

Name

Type

Description

subscription_numberStringThe subscription number related to the retrieved pending provisioning request as provided by CRM.COM
account_numberStringThe Subscription's Account Number as provided by the Generic Provider, retrieved by the Subscription Provisioning Provider Parameters
pending_provisioning_requests_setSet of Pending Provisioning Requests ObjectsThe generic provider pending provisioning requests related to the retrieved Subscription and ordered based on their scheduled date having the oldest retrieved first.

Referred Objects Response Data

 generic provider pending provisioning requests response data

Name

Type

Description

numberStringThe number of the retrieved provisioning request
typeString

A code that uniquely identifies the type of provisioning request. The supported options are the following:

  • BECOME_SUBSCRIBER
  • ACTIVATE_SERVICE
  • DEACTIVATE_SERVICE
  • ADD_INSTALLED_ITEM
  • REMOVE_INSTALLED_ITEM
  • ACTIVATE_SUBSCRIBER
  • DEACTIVATE_SUBSCRIBER
  • UPDATE_SUBSCRIBER
  • UPDATE_ADDRESS
  • ADD_UDR
  • CANCEL_UDR
executed_dateDateThe executed date of the provisioning request
addressAddress Object

The address that will set or update the subscriber's address. Available only for provisioning requests of type:

  • BECOME_SUBSCRIBER
  • UPDATE_SUBSCRIBER
  • UPDATE_ADDRESS
account_informationAccount Information ObjectThe subscriber's account information as stored in the generic provider. Available only for provisioning requests of type:
  • BECOME_SUBSCRIBER
  • UPDATE_SUBSCRIBER
serviceProvisioning Service ObjectThe provisioning service related to the provisioning request. Available only for provisioning requests of type:
  • ACTIVATE_SERVICE
  • DEACTIVATE_SERVICE
  • ADD_UDR
  • CANCEL_UDR
installed_itemProvisioning Installed Item ObjectThe provisioning installed item related to the provisioning request. Available only for provisioning requests of type:
  • ADD_INSTALLED_ITEM
  • REMOVE_INSTALLED_ITEM
services_set Provisioning Services Object SetThe provisioning services related to the provisioning request. Available only for provisioning requests of type:
  • BECOME_SUBSCRIBER
  • ACTIVATE_SUBSCRIBER
  • DEACTIVATE_SUBSCRIBER
installed_items_setProvisioning Installed Items Object SetThe provisioning installed items related to the provisioning request. Available only for provisioning requests of type:
  • BECOME_SUBSCRIBER

Referred Objects Response Data

 address object response data

From R14.2.0, the following object is applicable for CRM.COM Address Format

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

String

The postal code of the retrieved address

street_name

String

The street name of the retrieved address

street_number

String

The street number of the retrieved address

floor

Integer

The floor of the retrieved address

apartment_number

String

The apartment number of the retrieved address

area

String

The area of the retrieved address

town_city

String

The town / city of the retrieved address

district

String

The district of the retrieved address

municipality         

String

The municipality of the retrieved address

po_box

String

The PO box of the retrieved address

po_box_postal_code

String

The PO box postal code of the retrieved address

care_of

String

The care of person of the retrieved address

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

Defines if the address is the contact's primary address or not.

Available from CRM.COM R15

 

From R14.2.0, the following object is applicable for International Address Format

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

String

The postal code of the retrieved address

town_city

String

The town / city of the retrieved address

address_line_1

String

The address line 1

address_line_2

String

 The address line 2

state_province_county

String

The state or province or county of the address.

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

Defines if the address is the contact's primary address or not.

Available from CRM.COM R15

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 account information object response data

Name

Type

Description

owner_first_name

String

The first name of the subscription's owner

owner_last_nameStringThe last name of the subscription's owner
owner_email_addressStringThe email address of the subscription's owner. An active contact information email is retrieved if exists.

 generic provider service object response data

Name

Type

Description

product_code

String

The subscription service's product code as provided by CRM.COM

provisioning_system_identifierStringThe service's provisioning system identifier as provided by the Generic Provider

 generic provider installed item object response data

Name

Type

Description

product_type_nameStringThe installed item's product type name as provided by CRM.COM
serial_numberStringThe installed item's serial number as provided by CRM.COM
provisioning_system_identifierStringThe installed item's provisioning system identifier as provided by the Generic Provider
provisioning_physical_good_type_nameStringThe installed item's product type name as provided by the Generic Provider