Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for the automated process.
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
projectId
string
An identifier that is used to group Quotes that represent a unit of functionality that is important to a Buyer. A Project can be used to relate multiple Quotes together.
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
string
Text of the note
relatedContactInformation(Json Array)
emailAddress
string
Email address
name
string
Name of the contact
number
string
Phone number
numberExtension
string
Phone number extension
organization
string
The organization or company that the contact belongs to
role
string
The role of the particular contact in a given context.
postalAddress
Attribute Name
Type
Description
role
string
Role of this place
city
string
The city that the address is in
country
string
Country that the address is in
geographicalSubAddress
Attribute Name
Type
Description
buildingName
string
Allows for identification of places that require building name as part of addressing information
id
string
Unique Identifier of the subAddress
levelNumber
string
Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelType
string
Describes level types within a building
privateStreetName
string
Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumber
string
Private streets numbers internal to a private street
subUnit(Json Array)
subUnitNumber
string
The discriminator used for the subunit, often just a simple number but may also be a range.
subUnitType
string
The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
locality
string
The locality that the address is in
postcode
string
Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
postcodeExtension
string
An extension of a postal code. E.g. the part following the dash in an american urban property address
stateOrProvince
string
The State or Province that the address is in
streetName
string
Name of the street or other street type
streetNr
string
Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
streetNrLast
string
Last number in a range of street numbers allocated to a property
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
Payload value
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
Verizon
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
string
Text of the note
relatedContactInformation(Json Array)
emailAddress
string
Email address
name
string
Name of the contact
number
string
Phone number
numberExtension
string
Phone number extension
organization
string
The organization or company that the contact belongs to
role
string
The role of the particular contact in a given context.
postalAddress
Attribute Name
Type
Description
role
string
Role of this place
city
string
The city that the address is in
country
string
Country that the address is in
geographicalSubAddress
Attribute Name
Type
Description
buildingName
string
Allows for identification of places that require building name as part of addressing information
id
string
Unique Identifier of the subAddress
levelNumber
string
Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelType
string
Describes level types within a building
privateStreetName
string
Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumber
string
Private streets numbers internal to a private street
subUnit(Json Array)
subUnitNumber
string
The discriminator used for the subunit, often just a simple number but may also be a range.
subUnitType
string
The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
locality
string
The locality that the address is in
postcode
string
Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
postcodeExtension
string
An extension of a postal code. E.g. the part following the dash in an american urban property address
stateOrProvince
string
The State or Province that the address is in
streetName
string
Name of the street or other street type
streetNr
string
Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
streetNrLast
string
Last number in a range of street numbers allocated to a property
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa
reason
string
Text that explains the reason for the error. This can be shown to a client user.
message
string
Text that provides mode details and corrective actions related to the error. This can be shown to a client user.
referenceError
string
URL pointing to documentation describing the error
code
string
One of the following error codes:missingQueryParameter: The URI is missing a required query-string parameter missingQueryValue: The URI is missing a required query-string parameter value invalidQuery: The query section of the URI is invalid. invalidBody: The request has an invalid body
Response Body Parameters
Attribute Name
Type
Description
description
string
Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for the automated process.
externalId
string
ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
projectId
string
An identifier that is used to group Quotes that represent a unit of functionality that is important to a Buyer. A Project can be used to relate multiple Quotes together.
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
string
Text of the note
relatedContactInformation(Json Array)
emailAddress
string
Email address
name
string
Name of the contact
number
string
Phone number
numberExtension
string
Phone number extension
organization
string
The organization or company that the contact belongs to
role
string
The role of the particular contact in a given context.
postalAddress
Attribute Name
Type
Description
role
string
Role of this place
city
string
The city that the address is in
country
string
Country that the address is in
geographicalSubAddress
Attribute Name
Type
Description
buildingName
string
Allows for identification of places that require building name as part of addressing information
id
string
Unique Identifier of the subAddress
levelNumber
string
Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelType
string
Describes level types within a building
privateStreetName
string
Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumber
string
Private streets numbers internal to a private street
subUnit(Json Array)
subUnitNumber
string
The discriminator used for the subunit, often just a simple number but may also be a range.
subUnitType
string
The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
locality
string
The locality that the address is in
postcode
string
Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
postcodeExtension
string
An extension of a postal code. E.g. the part following the dash in an american urban property address
stateOrProvince
string
The State or Province that the address is in
streetName
string
Name of the street or other street type
streetNr
string
Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
streetNrLast
string
Last number in a range of street numbers allocated to a property
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
Payload value
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
Verizon
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
string
Text of the note
relatedContactInformation(Json Array)
emailAddress
string
Email address
name
string
Name of the contact
number
string
Phone number
numberExtension
string
Phone number extension
organization
string
The organization or company that the contact belongs to
role
string
The role of the particular contact in a given context.
postalAddress
Attribute Name
Type
Description
role
string
Role of this place
city
string
The city that the address is in
country
string
Country that the address is in
geographicalSubAddress
Attribute Name
Type
Description
buildingName
string
Allows for identification of places that require building name as part of addressing information
id
string
Unique Identifier of the subAddress
levelNumber
string
Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelType
string
Describes level types within a building
privateStreetName
string
Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumber
string
Private streets numbers internal to a private street
subUnit(Json Array)
subUnitNumber
string
The discriminator used for the subunit, often just a simple number but may also be a range.
subUnitType
string
The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
locality
string
The locality that the address is in
postcode
string
Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
postcodeExtension
string
An extension of a postal code. E.g. the part following the dash in an american urban property address
stateOrProvince
string
The State or Province that the address is in
streetName
string
Name of the street or other street type
streetNr
string
Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.
streetNrLast
string
Last number in a range of street numbers allocated to a property
A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa
reason
string
Text that explains the reason for the error. This can be shown to a client user.
message
string
Text that provides mode details and corrective actions related to the error. This can be shown to a client user.
referenceError
string
URL pointing to documentation describing the error
code
string
One of the following error codes:missingQueryParameter: The URI is missing a required query-string parameter missingQueryValue: The URI is missing a required query-string parameter value invalidQuery: The query section of the URI is invalid. invalidBody: The request has an invalid body
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 ProductOrderByQuotePOST 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>description</b></td><td>string</td><td>Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for the automated process.</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>projectId</b></td><td>string</td><td>An identifier that is used to group Quotes that represent a unit of functionality that is important to a Buyer. A Project can be used to relate multiple Quotes together.</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></td><td>string</td><td>Text of the note</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b>relatedContactInformation(Json Array)</b></td></tr><tr><td><b>emailAddress</b></td><td>string</td><td>Email address</td></tr><tr><td><b>name</b></td><td>string</td><td>Name of the contact</td></tr><tr><td><b>number</b></td><td>string</td><td>Phone number</td></tr><tr><td><b>numberExtension</b></td><td>string</td><td>Phone number extension</td></tr><tr><td><b>organization</b></td><td>string</td><td>The organization or company that the contact belongs to</td></tr><tr><td><b>role</b></td><td>string</td><td>The role of the particular contact in a given context.</td></tr><tr><td colspan="3"><div class="panel panel-default" id="postalAddressPostTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#postalAddressPostTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">postalAddress</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="postalAddressPostTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml postalAddressPost 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>role</b></td><td>string</td><td>Role of this place</td></tr><tr><td><b>city</b></td><td>string</td><td>The city that the address is in</td></tr><tr><td><b>country</b></td><td>string</td><td>Country that the address is in</td></tr><tr><td colspan="3"><div class="panel panel-default" id="geographicSubAddressTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#geographicSubAddressTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">geographicalSubAddress</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="geographicSubAddressTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml geographicSubAddressPost 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>buildingName</b></td><td>string</td><td>Allows for identification of places that require building name as part of addressing information</td></tr><tr><td><b>id</b></td><td>string</td><td>Unique Identifier of the subAddress</td></tr><tr><td><b>levelNumber</b></td><td>string</td><td>Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2</td></tr><tr><td><b>levelType</b></td><td>string</td><td>Describes level types within a building</td></tr><tr><td><b>privateStreetName</b></td><td>string</td><td>Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office</td></tr><tr><td><b>privateStreetNumber</b></td><td>string</td><td>Private streets numbers internal to a private street</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b>subUnit(Json Array)</b></td></tr><tr><td><b>subUnitNumber</b></td><td>string</td><td>The discriminator used for the subunit, often just a simple number but may also be a range.</td></tr><tr><td><b>subUnitType</b></td><td>string</td><td>The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.</td></tr></tbody></table></div></div></div></td></tr><tr><td><b>locality</b></td><td>string</td><td>The locality that the address is in</td></tr><tr><td><b>postcode</b></td><td>string</td><td>Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)</td></tr><tr><td><b>postcodeExtension</b></td><td>string</td><td>An extension of a postal code. E.g. the part following the dash in an american urban property address</td></tr><tr><td><b>stateOrProvince</b></td><td>string</td><td>The State or Province that the address is in</td></tr><tr><td><b>streetName</b></td><td>string</td><td>Name of the street or other street type</td></tr><tr><td><b>streetNr</b></td><td>string</td><td>Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.</td></tr><tr><td><b>streetNrLast</b></td><td>string</td><td>Last number in a range of street numbers allocated to a property</td></tr><tr><td><b>streetNrLastSuffix</b></td><td>string</td><td>Last street number suffix for a ranged address</td></tr><tr><td><b>streetNrSuffix</b></td><td>string</td><td>The first street number suffix</td></tr><tr><td><b>streetSuffix</b></td><td>string</td><td>A modifier denoting a relative direction</td></tr><tr><td><b>streetType</b></td><td>string</td><td>Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf</td></tr></tbody></table></div></div></div></td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b> productOrderItem(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;">productOrderItem</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>Payload value</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>Verizon</td></tr></tbody></table></div></div></div></td></tr></tbody></table></div></div></div></td></tr></tbody></table></div></div></div></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></td><td>string</td><td>Text of the note</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b>relatedContactInformation(Json Array)</b></td></tr><tr><td><b>emailAddress</b></td><td>string</td><td>Email address</td></tr><tr><td><b>name</b></td><td>string</td><td>Name of the contact</td></tr><tr><td><b>number</b></td><td>string</td><td>Phone number</td></tr><tr><td><b>numberExtension</b></td><td>string</td><td>Phone number extension</td></tr><tr><td><b>organization</b></td><td>string</td><td>The organization or company that the contact belongs to</td></tr><tr><td><b>role</b></td><td>string</td><td>The role of the particular contact in a given context.</td></tr><tr><td colspan="3"><div class="panel panel-default" id="postalAddressPostTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#postalAddressPostTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">postalAddress</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="postalAddressPostTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml postalAddressPost 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>role</b></td><td>string</td><td>Role of this place</td></tr><tr><td><b>city</b></td><td>string</td><td>The city that the address is in</td></tr><tr><td><b>country</b></td><td>string</td><td>Country that the address is in</td></tr><tr><td colspan="3"><div class="panel panel-default" id="geographicSubAddressTemplate"><div class="panel-heading collapsed" data-toggle="collapse" data-target="#geographicSubAddressTemplateTable"><h4 class="panel-title" style="display: inline; font-size: 11px;">geographicalSubAddress</h4><span class="vz-icon-arrow glyphicon glyphicon-chevron-up"> </span></div><div id="geographicSubAddressTemplateTable" class="panel-collapse collapse"><div class="panel-body requestDiv"><table style="width:100%" class="table_yaml geographicSubAddressPost 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>buildingName</b></td><td>string</td><td>Allows for identification of places that require building name as part of addressing information</td></tr><tr><td><b>id</b></td><td>string</td><td>Unique Identifier of the subAddress</td></tr><tr><td><b>levelNumber</b></td><td>string</td><td>Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2</td></tr><tr><td><b>levelType</b></td><td>string</td><td>Describes level types within a building</td></tr><tr><td><b>privateStreetName</b></td><td>string</td><td>Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office</td></tr><tr><td><b>privateStreetNumber</b></td><td>string</td><td>Private streets numbers internal to a private street</td></tr><tr class="subTitle"><td colspan="3" class="rtecenter"><b>subUnit(Json Array)</b></td></tr><tr><td><b>subUnitNumber</b></td><td>string</td><td>The discriminator used for the subunit, often just a simple number but may also be a range.</td></tr><tr><td><b>subUnitType</b></td><td>string</td><td>The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.</td></tr></tbody></table></div></div></div></td></tr><tr><td><b>locality</b></td><td>string</td><td>The locality that the address is in</td></tr><tr><td><b>postcode</b></td><td>string</td><td>Descriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)</td></tr><tr><td><b>postcodeExtension</b></td><td>string</td><td>An extension of a postal code. E.g. the part following the dash in an american urban property address</td></tr><tr><td><b>stateOrProvince</b></td><td>string</td><td>The State or Province that the address is in</td></tr><tr><td><b>streetName</b></td><td>string</td><td>Name of the street or other street type</td></tr><tr><td><b>streetNr</b></td><td>string</td><td>Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses.</td></tr><tr><td><b>streetNrLast</b></td><td>string</td><td>Last number in a range of street numbers allocated to a property</td></tr><tr><td><b>streetNrLastSuffix</b></td><td>string</td><td>Last street number suffix for a ranged address</td></tr><tr><td><b>streetNrSuffix</b></td><td>string</td><td>The first street number suffix</td></tr><tr><td><b>streetSuffix</b></td><td>string</td><td>A modifier denoting a relative direction</td></tr><tr><td><b>streetType</b></td><td>string</td><td>Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf</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 ProductOrderListGET 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>integer</td><td>A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa</td></tr><tr><td><b>reason</b></td><td>string</td><td>Text that explains the reason for the error. This can be shown to a client user.</td></tr><tr><td><b>message</b></td><td>string</td><td>Text that provides mode details and corrective actions related to the error. This can be shown to a client user.</td></tr><tr><td><b>referenceError</b></td><td>string</td><td>URL pointing to documentation describing the error</td></tr><tr><td><b>code</b></td><td>string</td><td>One of the following error codes:missingQueryParameter: The URI is missing a required query-string parameter missingQueryValue: The URI is missing a required query-string parameter value invalidQuery: The query section of the URI is invalid. invalidBody: The request has an invalid body</td></tr></tbody></table>
