Skip to end of banner
Go to start of banner

provisioning_request_complete

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Name

Type

Description

idStringThe ID of the retrieved provisioning request
numberStringThe number of the retrieved provisioning request
typeString

A code that uniquely identifies the type of provisioning request that is performed.

sequence_numberStringThe sequence number of the retrieved provisioning request
scheduled_dateDateThe date that the provisioning request is scheduled to be send
executed_dateDateThe date that the provisioning request was actually send
process_immediatelys 

 

life_cycle_stateStringThe life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
requestStringThe actual request that was send to Conax
responseStringThe actual response that was received from Conax
reference_numberStringA reference number provided by Conax after receiving the request
error_codeStringThe error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_descriptionStringThe error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_nameString

The name of the process that submitted the provisioning request, which can be one of the following:

  • PROVISIONING_REQUEST_PROCESSING
  • MAIL_BARK_MESSAGE_UTILITY
  • PAIRING_UTILITY
  • FIINGERPRINTING_UTILITY
  • RESET_PIN
  • MANUAL
process_idString

The ID of the process that submitted the provisioning request

provisioning_provider  
subscription  

log_information

Log Information Object

The log information related with the retrieved provisioning request

parameters_setSet of Conax Web Services Provisioning Request Item objectsThe parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

 provisioning_provider object response data

Name

Type

Description

id

String

The id of the retrieved provisioning provider

name

String

The name of the retrieved provisioning provider

alternative_code

String

The alternative code of the retrieved provisioning provider

descriptionStringThe description of the retrieved provisioning providers
provisioning_protocolStringThe provisioning protocol used by the provisioning provider

 subscription object response data

Name

Type

Description

id

String

The ID of the retrieved subscription

number

String

The number of the retrieved subscription

life_cycle_state

String

The life cycle state of the subscription. One of the following values is returned

DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION

REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0

PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0

first_activated_dateDate

The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owning the subscriptions
typeSubscription type objectThe type of the retrieved subscription

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 subscription type object response data

Name

Type

Description

id

String

The ID of the retrieved subscription type

name

String

The name of the retrieved subscription type

alternative_code

String

The alternative code of the retrieved subscription type

descriptionStringA description of the retrieved subscription type
classificationString

The classification of the retrieved subscription type, Flexible or Package

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 provisioning request parameter response data

Name

Type

Description

id

String

The ID of the retrieved provisioning request parameter

string_valueStringThe value of the retrieved provisioning request parameter, in case that the parameter type is string
integer_valueIntegerThe value of the retrieved provisioning request parameter, in case that the parameter type is integer
float_valueFloatThe value of the retrieved provisioning request parameter, in case that the parameter type is float
date_valueDateThe value of the retrieved provisioning request parameter, in case that the parameter type is date
clob_valueStringThe value of the retrieved provisioning request parameter, in case that the parameter type is clob

  • No labels