- Created by Former user, last modified by p_demou on Jul 07, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
This method returns the provisioning requests related to a generic provisioning provider having their life cycle state equal to Pending. Multiple provisioning requests can be retrieved that were created up to 7 days before the Web API's execution date. Provisioning requests retrieved should be grouped by Subscription and ordered based on their scheduled date having the oldest retrieved first.
Available from CRM.COM R12.1.0
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
provisioning_provider_identifier (mandatory) | Provisioning Provider Identifier | The identifier of the provisioning provider related with the provisioning requests that will be retrieved. The allowed provisioning identifer identifier fields are the following:
| ||||||||||||
number_of_results (mandatory) | Number | The number of results that can be retrieved through each call. The maximum number of results can be 50. The oldest provisioning requests are retrieved fist | ||||||||||||
offset (mandatory) | Number | It defines the number of provisioning requests that should be skipped from the results. During the first call it should be set to 0 and then it should be increased based on the number of results that were retrieved | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- N/A
Response Data
Name | Type | Description |
subscriptions_set | Set of Subscriptions to be provisioned Objects | The subscriptions related to generic provider pending provisioning requests |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
subscription_number | String | The subscription number related to the retrieved pending provisioning request as provided by CRM.COM |
account_number | String | The Subscription's Account Number as provided by the Generic Provider, retrieved by the Subscription Provisioning Provider Parameters |
pending_provisioning_requests_set | Set of Pending Provisioning Requests Objects | The 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
Name | Type | Description |
---|---|---|
number | String | The number of the retrieved provisioning request |
type | String | A code that uniquely identifies the type of provisioning request. The supported options are the following:
|
executed_date | Date | The executed date of the provisioning request |
address | Address Object | The address that will set or update the subscriber's address. Available only for provisioning requests of type:
|
account_information | Account Information Object | The subscriber's account information as stored in the generic provider. Available only for provisioning requests of type:
|
service | Provisioning Service Object | The provisioning service related to the provisioning request. Available only for provisioning requests of type:
|
installed_item | Provisioning Installed Item Object | The provisioning installed item related to the provisioning request. Available only for provisioning requests of type:
|
services_set | Provisioning Services Object Set | The provisioning services related to the provisioning request. Available only for provisioning requests of type:
|
installed_items_set | Provisioning Installed Items Object Set | The provisioning installed items related to the provisioning request. Available only for provisioning requests of type:
|
Referred Objects 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 Object | The country of the retrieved address | |
is_primary | Boolean | 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 Object | The country of the retrieved address | |
is_primary | Boolean | Defines if the address is the contact's primary address or not. Available from CRM.COM R15 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
owner_first_name | String | The first name of the subscription's owner |
owner_last_name | String | The last name of the subscription's owner |
owner_email_address | String | The email address of the subscription's owner. An active contact information email is retrieved if exists. |
Name | Type | Description |
---|---|---|
product_code | String | The subscription service's product code as provided by CRM.COM |
provisioning_system_identifier | String | The service's provisioning system identifier as provided by the Generic Provider |
Name | Type | Description |
---|---|---|
product_type_name | String | The installed item's product type name as provided by CRM.COM |
serial_number | String | The installed item's serial number as provided by CRM.COM |
provisioning_system_identifier | String | The installed item's provisioning system identifier as provided by the Generic Provider |
provisioning_physical_good_type_name | String | The installed item's product type name as provided by the Generic Provider |
Examples
HTTP Method: GET
Request:
Response:
{ "data": [ { "account_number": "ACR0000003648", "subscription_number": "S0000003626", "pending_provisioning_requests_set": [ { "number": "202091", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "BUSINESS", "udf_date_2": null, "udf_date_1": null, "street_name": "Elia Papakyriakou", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "17068354C6E04B27A65CE41CB41E7D0D", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "12", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-09T15:02:00", "account_information": { "owner_email_address": null, "owner_first_name": "Stella", "owner_last_name": "Stylianidou" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003655", "subscription_number": "S0000003632", "pending_provisioning_requests_set": [ { "number": "202097", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "HOME", "udf_date_2": null, "udf_date_1": null, "street_name": "gfggf", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "943F903DBA8F489EA8BBEF8A01E0F0E5", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": null, "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-10T08:04:46", "account_information": { "owner_email_address": null, "owner_first_name": "Pavlos", "owner_last_name": "Eliades" }, "services_set": [ { "provisioning_system_identifier": "3", "product_code": "Gold" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003646", "subscription_number": "S0000003624", "pending_provisioning_requests_set": [ { "number": "202034", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "HOME", "udf_date_2": null, "udf_date_1": null, "street_name": "asd", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "EBF43C257E184997B36D2B97A0AEFB79", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "1", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-09T13:02:05", "account_information": { "owner_email_address": null, "owner_first_name": "Generic", "owner_last_name": "Test 1" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003653", "subscription_number": "S0000003630", "pending_provisioning_requests_set": [ { "number": "202095", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "HOME", "udf_date_2": null, "udf_date_1": null, "street_name": "asad", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "1242DA30435642FA92E4592B213E840A", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "1", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-09T15:31:59", "account_information": { "owner_email_address": null, "owner_first_name": "Generic", "owner_last_name": "Test 1" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003647", "subscription_number": "S0000003625", "pending_provisioning_requests_set": [ { "number": "202043", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "HOME", "udf_date_2": null, "udf_date_1": null, "street_name": "sddfs", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "5EAE740398D547FC803AB49E3AFDDA3B", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "1", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-09T13:09:00", "account_information": { "owner_email_address": null, "owner_first_name": "Generic", "owner_last_name": "Test 2" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] }, { "number": "202045", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "HOME", "udf_date_2": null, "udf_date_1": null, "street_name": "sddfs", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "5EAE740398D547FC803AB49E3AFDDA3B", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "1", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-09T13:11:38", "account_information": { "owner_email_address": null, "owner_first_name": "Generic", "owner_last_name": "Test 2" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003654", "subscription_number": "S0000003631", "pending_provisioning_requests_set": [ { "number": "202096", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "BUSINESS", "udf_date_2": null, "udf_date_1": null, "street_name": "Stavrou", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "8D57021F1FBC4A06A551766799901FEC", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": "10", "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-10T08:00:09", "account_information": { "owner_email_address": null, "owner_first_name": "Elena", "owner_last_name": "Ioannou" }, "services_set": [ { "provisioning_system_identifier": "3", "product_code": "Gold" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003656", "subscription_number": "S0000003633", "pending_provisioning_requests_set": [ { "number": "202098", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "BUSINESS", "udf_date_2": null, "udf_date_1": null, "street_name": "khjkhjkk", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "BC1BBB3B44994FD89C15572B978C6688", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": null, "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-10T08:20:11", "account_information": { "owner_email_address": null, "owner_first_name": "Stelios", "owner_last_name": "Eliades" }, "services_set": [ { "provisioning_system_identifier": "1", "product_code": "Bronze" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] }, { "account_number": "ACR0000003657", "subscription_number": "S0000003634", "pending_provisioning_requests_set": [ { "number": "202099", "address": { "apartment_number": null, "care_of": null, "country": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "municipality": null, "type": "BUSINESS", "udf_date_2": null, "udf_date_1": null, "street_name": "mn,n,", "udf_date_4": null, "udf_date_3": null, "udf_float_3": null, "udf_float_4": null, "po_box_postal_code": null, "udf_string_15": null, "udf_string_16": null, "udf_string_13": null, "udf_string_14": null, "udf_string_11": null, "udf_string_12": null, "id": "E71EA0B2F5214F21BC81769C1C5885D1", "state": "Active", "udf_string_10": null, "floor": null, "udf_float_1": null, "udf_float_2": null, "area": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "po_box": null, "town_city": null, "district": null, "street_number": null, "postal_code": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "udf_string_9": null }, "executed_date": "2017-02-10T08:24:35", "account_information": { "owner_email_address": null, "owner_first_name": "Maria", "owner_last_name": "Ioannou" }, "services_set": [ { "provisioning_system_identifier": "3", "product_code": "Gold" } ], "type": "BECOME_SUBSCRIBER", "installed_items_set": [] } ] } ], "status": { "code": "OK", "description": "", "message": "" } }
- No labels