quoteById

get

quoteById

The Customer requests a list of Quotes from Verizon based on a set of filter criteria (as described in MEF 80). For each Quote returned, the Verizon also provides a Quote Identifier that uniquely identifies this Quote within Verizon. The order of the elements returned to the Customer is defined by Verizon (e.g. natural order) and does not change between the pages.

Resource URL

 
Environment URL
Production

https://digitalconnectproxy-qa.ebiz.verizon.com//usp/quoteById    

Test

https://digitalconnectproxy-qa.ebiz.verizon.com//usp/quoteById    

Query Parameters


Name Values Description
externalId
(required)

The Customer requests a list of Quotes from Verizon based on a set of filter criteria (as described in MEF 80). For each Quote returned, the Verizon also provides a Quote Identifier that uniquely identifies this Quote within Verizon. The order of the elements returned to the Customer is defined by Verizon (e.g. natural order) and does not change between the pages.


Attribute Name Type Description
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.
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.
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
Attribute NameTypeDescription
buildingNamestringAllows for identification of places that require building name as part of addressing information
idstringUnique Identifier of the subAddress
levelNumberstringUsed where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelTypestringDescribes level types within a building
privateStreetNamestringPrivate streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumberstringPrivate streets numbers internal to a private street
subUnit(Json Array)
subUnitNumberstringThe discriminator used for the subunit, often just a simple number but may also be a range.
subUnitTypestringThe 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
streetNrLastSuffix string Last street number suffix for a ranged address
streetNrSuffix string The first street number suffix
streetSuffix string A modifier denoting a relative direction
streetType string Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
Attribute Name Type Description
id string Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)
action string Product action to be applied to the Quote Item. This corresponds to the Order Item Action when an associated product is ordered.
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
idstringId of an item of a product offering qualification
alternateProductProposalIdstringA unique identifier for the Alternate Product Proposal assigned by the Seller, if the referenced qualification comes from an alternate product proposal.
productOfferingQualificationHrefstringReference of the related Product Offering Qualification.
productOfferingQualificationIdstringUnique identifier of related Product Offering Qualification.
Attribute NameTypeDescription
buyerProductIdstringThe unique identifier of an in-service Product that is the quotations 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.
place(Json Array)
rolestringRole of this place
typestringThis field is used as a discriminator and is used between different place representations. This type might discriminate for the additional related place as defined in @schemaLocation.
addrLine1stringAlley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
citystringThe city that the address is in
statestringThe State or Province that the address is in
postcodestringDescriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
countrystringCountry that the address is in
productConfiguration(String)
Attribute Name Type Description
name string Name of payload paramenters
valueType string Payload 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
relatedContactInformation(Json Array)
role string The role of the particular contact in a given context.
name string Name of the contact
emailAddress string Email address
number string Phone number
Attribute NameTypeDescription
amountstringDuration (number of seconds, minutes, hours, etc.)
unitsstringRepresents a unit of time. Reference: MEF 79 (Sn 8.4.3.1/8.4.3.2)
Attribute NameTypeDescription
idstringId of an item of a product offering qualification
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
note(Json Array)
id string Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
author string Author of the note
date string Date of the note
source string Indicates if the note is from Buyer or Seller.
text string Text of the note
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)
requestedQuoteCompletionDate string This is requested date - from quote requester - to get a complete request for this quote
Attribute Name Type Description
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.
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.
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
Attribute NameTypeDescription
buildingNamestringAllows for identification of places that require building name as part of addressing information
idstringUnique Identifier of the subAddress
levelNumberstringUsed where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
levelTypestringDescribes level types within a building
privateStreetNamestringPrivate streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
privateStreetNumberstringPrivate streets numbers internal to a private street
subUnit(Json Array)
subUnitNumberstringThe discriminator used for the subunit, often just a simple number but may also be a range.
subUnitTypestringThe 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
streetNrLastSuffix string Last street number suffix for a ranged address
streetNrSuffix string The first street number suffix
streetSuffix string A modifier denoting a relative direction
streetType string Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
Attribute Name Type Description
id string Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)
action string Product action to be applied to the Quote Item. This corresponds to the Order Item Action when an associated product is ordered.
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
Attribute NameTypeDescription
idstringId of an item of a product offering qualification
alternateProductProposalIdstringA unique identifier for the Alternate Product Proposal assigned by the Seller, if the referenced qualification comes from an alternate product proposal.
productOfferingQualificationHrefstringReference of the related Product Offering Qualification.
productOfferingQualificationIdstringUnique identifier of related Product Offering Qualification.
Attribute NameTypeDescription
buyerProductIdstringThe unique identifier of an in-service Product that is the quotations 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.
place(Json Array)
rolestringRole of this place
typestringThis field is used as a discriminator and is used between different place representations. This type might discriminate for the additional related place as defined in @schemaLocation.
addrLine1stringAlley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
citystringThe city that the address is in
statestringThe State or Province that the address is in
postcodestringDescriptor for a postal delivery area used to speed and simplify the delivery of mail (also known as zip code)
countrystringCountry that the address is in
productConfiguration(String)
Attribute Name Type Description
name string Name of payload paramenters
valueType string Payload 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
relatedContactInformation(Json Array)
role string The role of the particular contact in a given context.
name string Name of the contact
emailAddress string Email address
number string Phone number
Attribute NameTypeDescription
amountstringDuration (number of seconds, minutes, hours, etc.)
unitsstringRepresents a unit of time. Reference: MEF 79 (Sn 8.4.3.1/8.4.3.2)
Attribute NameTypeDescription
idstringId of an item of a product offering qualification
agreementName string Name of the agreement. The name is unique between the Buyer and the Seller.
note(Json Array)
id string Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
author string Author of the note
date string Date of the note
source string Indicates if the note is from Buyer or Seller.
text string Text of the note
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)
requestedQuoteCompletionDate string This is requested date - from quote requester - to get a complete request for this quote

Body Parameters


Name Values Description
response
(required)

Sample Request

 

Please login to send the sample request and get a reponse back.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 401
    401

    Authentication Error

Working...