A request initiated by the Customer to determine whether Verizon is able to deliver a Switched E-Line product or from Verizon's product offerings, at the Customer's location(s); or modify a previously purchased product. Verizon also provides estimated time intervals to complete these deliveries. Reference: MEF 79 (Sn 8.4).
If this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative
boolean
Allows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectId
string
This value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDate
string
The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name optional
string
Name of the contact
emailAddress optional
string
Email address
number
string
Phone number
note(Json Array)
id
string
Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text optional
string
Content of the Note
productOfferingQualificationItem(Json Array)
productOfferingQualificationItem
Attribute Name
Type
Description
action
string
Action to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
id
string
Id of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementName
string
Name of the agreement. The name is unique between the Buyer and the Seller.
product
Attribute Name
Type
Description
value
Attribute Name
Type
Description
id
string
The unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
productOffering
Attribute Name
Type
Description
id
string
id of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
productConfiguration
Attribute Name
Type
Description
type
string
The name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
productCharacteristic
Attribute Name
Type
Description
name
string
Name of the product characteristic
valueType
string
TBD
value
Attribute Name
Type
Description
physicalLayer
string
Which could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeed
string
Speed of access link to Verizon POP
uniSpeed
string
UNI Speed
connectorType
string
Type of connector such as Single Mode or Multi-mode
power
string
DC or AC Power
customerHandoff
string
All types of access out of PQ i.e, Ethernet
accessDesign
string
Standalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwner
string
TBD
Attribute Name
Type
Description
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative
boolean
Allows the Buyer to indicate if he is willing to get an alternate proposal if responseed product not available.
projectId
string
This value MAY be assigned by the Buyer to identify a project the serviceability response is associated with.
responseedPOQCompletionDate
string
The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
Response Body Parameters
Attribute Name
Type
Description
instantSyncQualification
boolean
If this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative
boolean
Allows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.
projectId
string
This value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.
requestedPOQCompletionDate
string
The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
relatedContactInformation(Json Array)
role(Json Array)
name optional
string
Name of the contact
emailAddress optional
string
Email address
number
string
Phone number
note(Json Array)
id
string
Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text optional
string
Content of the Note
productOfferingQualificationItem(Json Array)
productOfferingQualificationItem
Attribute Name
Type
Description
action
string
Action to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).
id
string
Id of this POQ item which is unique within the POQ. Assigned by the Buyer.
agreementName
string
Name of the agreement. The name is unique between the Buyer and the Seller.
product
Attribute Name
Type
Description
value
Attribute Name
Type
Description
id
string
The unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.
productOffering
Attribute Name
Type
Description
id
string
id of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.
productConfiguration
Attribute Name
Type
Description
type
string
The name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.
productCharacteristic
Attribute Name
Type
Description
name
string
Name of the product characteristic
valueType
string
TBD
value
Attribute Name
Type
Description
physicalLayer
string
Which could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;
accessSpeed
string
Speed of access link to Verizon POP
uniSpeed
string
UNI Speed
connectorType
string
Type of connector such as Single Mode or Multi-mode
power
string
DC or AC Power
customerHandoff
string
All types of access out of PQ i.e, Ethernet
accessDesign
string
Standalone Loop (Customer direct access to Verizon network where UNI is at customer location)
accessOwner
string
TBD
Attribute Name
Type
Description
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
provideAlternative
boolean
Allows the Buyer to indicate if he is willing to get an alternate proposal if responseed product not available.
projectId
string
This value MAY be assigned by the Buyer to identify a project the serviceability response is associated with.
responseedPOQCompletionDate
string
The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false
OAuth 2.0 is the industry-standard protocol for authentication and authorization. All Verizon APIs are protected by OAuth 2.0.
1) Obtain the client credentials by subscribing to the API
Client applications need Client ID and Client Secret to obtain the oAuth 2.0 access token. TO obtain the client credentials , go to the 'Develop' tab click on the "Subscribe Now" button to subscribe to an API.Once the subsription has been approved,click on the subscription name to obtain the client key and secret.Separate client credentials are provided for test and production environment.
For the production environment,the Client ID and Secret are provided only to the Company Admin.
2) Obtain the accessToken.
Before the client application can access Verizon APIs , it must obtain an access token that grants access to that API.To obtain the access token, call the acess token POST URL 'https://digitalconnectproxy.verizon.com:443/oauthv1/client_credential/accesstoken?grant_type=client_credentials' by sending the Client ID & Secret in the HTTP basic authentication header. The body of this request should be set to 'grant_type=client_credentials'.
3) Invoke the API.
Once the access token is obtained, invoke the API call with the accesstoken set in the HTTP authorization header.
4) Refresh the accesstoken.
Access tokens have limited lifetimes. The access token Verizon issues are valid for 60 minutes. If the client applications needs invoke the API beyond the lifetime of a single access token, a new access token is to be obtained. Invoke the access token URL every 55 mins to get a new token.
<table style="width:100%" class="table_yaml ProductOfferingQualificationPOST request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>instantSyncQualification</b></td><td>boolean</td><td>If this flag is set to Yes, Buyer requests to have an instant qualification to be provided in operation POST response</td></tr><tr><td><b>externalId</b></td><td>string</td><td>ID given by the consumer and only understandable by him (to facilitate his searches afterwards)</td></tr><tr><td><b>provideAlternative</b></td><td>boolean</td><td>Allows the Buyer to indicate if he is willing to get an alternate proposal if requested product not available.</td></tr><tr><td><b>projectId</b></td><td>string</td><td>This value MAY be assigned by the Buyer to identify a project the serviceability request is associated with.</td></tr><tr><td><b>requestedPOQCompletionDate</b></td><td>string</td><td>The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b> relatedContactInformation(Json Array)</b></td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b> role(Json Array)</b></td></tr><tr><td><b>name</b><br>optional</td><td>string</td><td>Name of the contact</td></tr><tr> <td><b>emailAddress</b><br>optional</td> <td>string</td> <td>Email address</td></tr><tr> <td><b>number</b></td> <td>string</td> <td>Phone number</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b> note(Json Array)</b></td></tr><tr><td><b>id</b></td><td>string</td><td>Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)</td></tr><tr><td><b>text</b><br>optional</td><td>string</td> <td>Content of the Note</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b> productOfferingQualificationItem(Json Array)</b></td></tr><tr><td colspan="3"><div class="panel panel-default" id="productOfferingQualificationItemTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productOfferingQualificationItemTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">productOfferingQualificationItem</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productOfferingQualificationItemTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productOfferingQualificationItemPost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>action</b></td><td>string</td><td>Action to be performed on the Product Item. The action types are described in MEF 79 (Sn 8.4.1.1).</td></tr><tr><td><b>id</b></td><td>string</td><td>Id of this POQ item which is unique within the POQ. Assigned by the Buyer.</td></tr><tr><td><b>agreementName</b></td><td>string</td><td>Name of the agreement. The name is unique between the Buyer and the Seller.</td></tr><tr><td colspan="3"><div class="panel panel-default" id="productTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">product</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td colspan="3"><div class="panel panel-default" id="productSpecificationTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productSpecificationTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">value</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productSpecificationTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productSpecificationTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>id</b></td><td>string</td><td>The unique identifier of an in-service Product that is the qualifications subject. This field MUST be populated if an item action is either modify or delete. This field MUST NOT be populated if an item action is add.</td></tr></tbody></table></div></div></div></td></tr><tr><td colspan="3"><div class="panel panel-default" id="productOfferingTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productOfferingTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">productOffering</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productOfferingTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productOfferingTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>id</b></td><td>string</td><td>id of a Product Offering. It is assigned by the Seller. The Buyer and the Seller exchange information about offerings ids during the onboarding process.</td></tr></tbody></table></div></div></div></td></tr> <tr><td colspan="3"><div class="panel panel-default" id="productConfigurationTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productConfigurationTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">productConfiguration</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productConfigurationTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productConfigurationTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>type</b></td><td>string</td><td>The name of the type that uniquely identifies the type of the product that is the subject of the POQ Request. In case of MEF product this is the URN provided in the Product Specification.</td></tr></tbody></table></div></div></div></td></tr><tr><td colspan="3"><div class="panel panel-default" id="productCharacteristicTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productCharacteristicTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">productCharacteristic</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productCharacteristicTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productCharacteristicTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>name</b></td><td>string</td><td>Name of the product characteristic</td></tr><tr><td><b>valueType</b></td><td>string</td><td>TBD</td></tr><tr><td colspan="3"><div class="panel panel-default" id="productValueTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#productValueTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">value</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="productValueTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml productValueTemplatePost request"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>physicalLayer</b></td><td>string</td><td>Which could be one of the following PHY interfaceIEEE Std 802.3 – 2015 but excluding 1000BASE-PX-D and 1000BASE-PX-U,IEEE Std 802.3bp – 2016,IEEE Std 802.3bq – 2016,IEEE Std 802.3bs – 2017,IEEE Std 802.3bu – 2016,IEEE Std 802.3bv – 2017,IEEE Std 802.3by – 2016,IEEE Std 802.3bz – 2016;</td></tr><tr><td><b>accessSpeed</b></td><td>string</td><td>Speed of access link to Verizon POP</td></tr><tr><td><b>uniSpeed</b></td><td>string</td><td>UNI Speed</td></tr><tr><td><b>connectorType</b></td><td>string</td><td>Type of connector such as Single Mode or Multi-mode</td></tr><tr><td><b>power</b></td><td>string</td><td>DC or AC Power</td></tr><tr><td><b>customerHandoff</b></td><td>string</td><td>All types of access out of PQ i.e, Ethernet</td></tr><tr><td><b>accessDesign</b></td><td>string</td><td>Standalone Loop (Customer direct access to Verizon network where UNI is at customer location)</td></tr><tr><td><b>accessOwner</b></td><td>string</td><td>TBD</td></tr></tbody></table></div></div></div></td></tr></tbody></table></div></div></div></td></tr></tbody></table></div></div></div></td></tr></tbody></table></div></div></div></td></tr></tbody></table>
<table style="width:100%" class="table_yaml ProductOfferingQualificationGET response"><thead><tr><th class="rtecenter" scope="col">Attribute Name</th><th class="rtecenter" scope="col">Type</th><th class="rtecenter" scope="col">Description</th></tr></thead><tbody style="vertical-align:top;"><tr><td><b>externalId</b></td><td>string</td><td>ID given by the consumer and only understandable by him (to facilitate his searches afterwards)</td></tr><tr><td><b>provideAlternative</b></td><td>boolean</td><td>Allows the Buyer to indicate if he is willing to get an alternate proposal if responseed product not available.</td></tr><tr><td><b>projectId</b></td><td>string</td><td>This value MAY be assigned by the Buyer to identify a project the serviceability response is associated with.</td></tr><tr><td><b>responseedPOQCompletionDate</b></td><td>string</td><td>The latest date a the POQ completion is expected. This attribute is required when instantSyncQualification=false</td></tr></tbody></table>
