GET provisioning/provisioning_requests/show
- Former user (Deleted)
- p_demou (Deactivated)
Available from CRM.COM R11.0.0
This method returns information related with a provisioning request. A single provisioning requests is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| provisioning_request_identifier (semi-optional) | Provisioning Request identifier | The identifier of the provisioning request that should be returned as a result. The allowed provisioning request identifier fields are the following:
| |||||||||
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
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved provisioning request |
| number | String | The number of the retrieved provisioning request |
| type | String | A code that uniquely identifies the type of provisioning request that is performed. The type depends on the provisioning provider related to the provisioning request |
| sequence_number | String | The sequence number of the retrieved provisioning request |
| scheduled_date | Date | The date that the provisioning request was scheduled to be sent |
| executed_date | Date | The date that the provisioning request was actually send |
| process_immediately | Boolean | Determines if the provisioning request will be processed immediately or not |
| life_cycle_state | String | The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED |
| request | String | The actual request that was sent to the provisioning system |
| response | String | The actual response that was received from the provisioning system |
| reference_number | String | A reference number provided by provisioning system after receiving the request |
| error_code | String | The error code received by CRM.COM or the provisioning system in case that the provisioning request was rejected |
| error_description | String | The error description received by CRM.COM or the provisioning system in case that the provisioning request was rejected |
| process_name | String | The name of the process that submitted the provisioning request |
| process_id | String | The ID of the process that submitted the provisioning request |
| provisioning_provider | Provisioning Provider Object | The provisioning provider that processed the provisioning request |
| subscription | Subscription Object | The subscription that was provisioned by the provisioning request |
| parameters_set | Set of Provisioning Request Parameters Objects | The parameters related to the retrieved provisioning request. That information is different based on the type of provisioning request |
Log Information Object | The log information related to the retrieved provisioning request |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data":
{
"request": "createAccountFromTve/addressCountry=ZM&tveAdapter=Test&allowNews=true&providerId=8E57FA9E894241E491A3335EAB0DA5D9&acceptTerms=true&userId=0E9B89BBDC2F4B8B8D31B02AB28E76B8&username=S0000000327",
"process_id": "76FD2AAD9E0945F08F2F47E5AF1E8A2F",
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-11-02T16:48:38",
"updated_date": "2016-11-02T16:48:53",
"updated_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"life_cycle_state": "COMPLETED",
"subscription":
{
"number": "S0000000327",
"first_activated_date": "2016-11-02T16:48:36",
"rating_state": "PENDING",
"accounts_receivable":
{
"number": "ACR0000000510",
"name": "Tucano_2",
"id": "22CAF157C73047B69D97D8FF3F0B8E5B",
"life_cycle_state": "ACTIVE",
"account_owner":
{
"company_profile": null,
"company_name": null,
"name": "Tucano Provider_2",
"last_name": "Provider_2",
"id": "8511819001394E4AB50FEEC75ABCD4C6",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Tucano",
"demographics":
{
"name_day":
{
"month": null,
"day": null
},
"id_number": "854693",
"gender": null,
"country_of_residence":
{
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth":
{
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "0E9B89BBDC2F4B8B8D31B02AB28E76B8",
"life_cycle_state": "EFFECTIVE"
},
"type": "CREATE_ACCOUNT",
"scheduled_date": "2016-11-02T16:48:38",
"reference_number": null,
"process_immediately": true,
"sequence_number": null,
"parameters_set":
[
{
"string_value": null,
"date_value": null,
"float_value": null,
"id": "D8F1594DDBD7463192405DFA9C70F42D",
"integer_value": null,
"clob_value": "080AB74B34A148CC9DE52E198E570E5A"
}
],
"number": "97",
"executed_date": "2016-11-02T16:48:53",
"response": "{"result":{"confirmEmailSent":false},"error":null,"status":true}",
"error_description": null,
"process_name": "SUBSCRIPTION_ACTION",
"provisioning_provider":
{
"alternative_code": "AT",
"name": "AlphaNetworks Tucano",
"description": null,
"id": "8E57FA9E894241E491A3335EAB0DA5D9",
"provisioning_protocol": "TUCANO"
},
"error_code": null,
"id": "8C2792D45B1A4B579ED47666FE54CB5D"
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}