POST provisioning/generic_provisioning_requests/send_response

Available from CRM.COM R12.1.0

This method is used to approve or reject pending provisioning requests which are provisioned through a generic provisioning provider. Multiple provisioning requests can be specified in each call

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 to the provisioning requests that will be retrieved. The allowed provisioning identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning provider

name

(semi-optional)

String

The name of the provisioning provider

alternative_code

(semi-optional)

String

The alternative code of the provisioning provider

responses_set

(mandatory)

Set of Provisioning Request ResponsesThe provider's response per provisioning request.

Referred Parameter Objects Data

 provisioning request responses parameter object data

Name

Type

Description

number

(mandatory)

String

The number of the provisioning request processed by the Generic Provider as provided by CRM.COM

response_status

(mandatory)

String

The Generic Provider's response status. Two options are available:

  • ACCEPTED
  • REJECTED

error_code

(optional)

StringThe error code to be sent by the Provider. Applicable only if response status is set to "Rejected"

error_description

(optional)

StringThe error description to be sent by the Provider. Applicable only if response status is set to "Rejected"

account_number

(optional)

String

The Subscription's Account Number as provided by the Generic Provider. Applicable only if provisioning request is of type:

  • BECOME_SUBSCRIBER

Response Data

Name

Type

Description

failed_provisioning_requests_setSet of Failed Provisioning Requests Objects

The Generic Provider's provisioning requests that failed to be processed by CRM.COM

Referred Objects Response Data

 Failed generic provider provisioning requests response data

Name

Type

Description

number

String

The number of the failed provisioning request as provided by CRM.COM


Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 {
"token":"{{token}}",
  "provisioning_provider_identifier":{"alternative_code":"GP1"},
  "responses_set":[
  	{
  		"number":"202095",
  		"response_status":"ACCEPTED",
  		"account_number":"ACR0000003653"
  	}
  	,
  	 {
      "number":"202096",
      "response_status":"REJECTED",
      "error_code":"Rejected_By_Provider",
      "error_description":"Rejected by Provider"
     } 
  	]
}

Response:

 {
  "data": [],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
 Example 2

HTTP Method: POST

 

Request:

Body:

{
"token":"{{token}}",
  "provisioning_provider_identifier":{"alternative_code":"GP1"},
  "responses_set":[
  	{
  		"number":"202099",
  		"response_status":"ACCEPTED",
  	}
  	,
  	 {
      "number":"202034",
      "response_status":"REJECTED",
      "error_code":"Rejected_By_Provider",
      "error_description":"Rejected by Provider"
     } 
  	]
}

Response:

{
  "data": [
    {
      "number": "202099"
    },
    {
      "number": "202034"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}