Cookies Settings

Loading

dnb-logo
Direct 2.0
Collapse

List User Preference

IMPORTANT: Version 2.2 is the latest available service for Direct 2.0 customers.

This function allows a customer to review active user preferences.

Update History

No modifications have been made to this data layer since the initial release.

What to do First

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This particular feature does not require entitlement for production and trial usage for D&B Direct 2.0 customers.

Specification

Sample Request (List)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="http://services.dnb.com/UserServiceV2.0">
     <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>MyUserName</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <user:ListPreferenceRequest ServiceVersionNumber="2.0">
      	<user:ListPreferenceRequestDetail>
      		<user:PreferenceListCriteria>
               	<user:CreatedFromDate>2013-08-15</user:CreatedFromDate>
               	<user:CreatedToDate>2013-08-30</user:CreatedToDate>
               </user:PreferenceListCriteria>
          </user:ListPreferenceRequestDetail>
      </user:ListPreferenceRequest>
   </soapenv:Body>
</soapenv:Envelope>
Note: This sample is for illustrative purposes only. Actual calls using the sample parameters may not produce the same results.
Name Characteristics
ListPreferenceRequest Aggregate
ListPreferenceRequest@ServiceVersionNumber Attribute
ListPreferenceRequest. TransactionDetail Aggregate, Optional
ListPreferenceRequest. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional
ListPreferenceRequest. TransactionDetail. TransactionTimestamp DateTimestamp, Optional
ListPreferenceRequest. TransactionDetail. SubmittingOfficeID string up to 64 chars., Optional
END: ListPreferenceRequest. TransactionDetail /Aggregate
ListPreferenceRequest. ListPreferenceRequestDetail Aggregate, Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria Aggregate, Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. PreferenceType PreferenceTypeEnum, Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. ApplicationAreaName ApplicationAreaEnum, Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. PreferenceName string up to 64 chars., Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. PreferenceDescription string up to 256 chars., Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. PreferenceValueText string up to 1024 chars., Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedFromDate date, Optional

Records the start date of the date range to list the user preference

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedFromDate@DatePrecisionText Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedFromDate@DatePrecisionDNBCodeValue Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedFromDate@DatePrecisionDNBCodeTableNumber Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedToDate date, Optional

Records the enddate of the date range to list the user preference

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedToDate@DatePrecisionText Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedToDate@DatePrecisionDNBCodeValue Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. CreatedToDate@DatePrecisionDNBCodeTableNumber Attribute
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. PreferenceStatusText PreferenceStatusTextEnum, Optional

Records the status of the monitoring profile

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria. DefaultPreference boolean, Optional
END: ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceListCriteria /Aggregate
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification Aggregate, Optional
ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification. SortBasisText PreferenceSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification. SortDirectionText SortDirectionEnum, Optional

Records the direction of sorting. Possbile values are Ascending, Descending

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification. CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional

Records the maximum quantity that can be displayed per page

ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification. CandidateDisplayStartSequenceNumber int, Optional

Records the Display sequence number of the results

END: ListPreferenceRequest. ListPreferenceRequestDetail. PreferenceDisplaySpecification /Aggregate
END: ListPreferenceRequest. ListPreferenceRequestDetail /Aggregate
END: ListPreferenceRequest /Aggregate

Endpoint

Use the following endpoint with the downloadable WSDL to request this feature.

Endpoint (User)
https://direct.dnb.com/UserService/V{version}

Testing

This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.

Feature Response

Specification

The following is a list of the possible data fields returned by this operation in the XML response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

Sample Response (List)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap-env:Body xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
      <user:ListPreferenceResponse ServiceVersionNumber="2.2" xmlns:user="http://services.dnb.com/UserServiceV2.0">
         <user:TransactionDetail>
            <user:ServiceTransactionID>Id-f84b69a9520e3a37232b742e-1</user:ServiceTransactionID>
            <user:TransactionTimestamp>2013-08-16T10:42:00.031-04:00</user:TransactionTimestamp>
         </user:TransactionDetail>
         <user:TransactionResult>
            <user:SeverityText>Information</user:SeverityText>
            <user:ResultID>CM000</user:ResultID>
            <user:ResultText>Success</user:ResultText>
         </user:TransactionResult>
         <user:ListPreferenceResponseDetail>
            <user:CandidateMatchedQuantity>2</user:CandidateMatchedQuantity>
            <user:CandidateReturnedQuantity>2</user:CandidateReturnedQuantity>
            <user:PreferenceDetail>
               <user:PreferenceType>HTTPCallBack</user:PreferenceType>
               <user:ApplicationAreaName>Monitoring</user:ApplicationAreaName>
               <user:PreferenceName>MyCompany-HTTPCallBack</user:PreferenceName>
               <user:PreferenceDescription>MyCompany's HTTPCallBack URI</user:PreferenceDescription>
               <user:PreferenceValueText>https://www.mycompany.com/httppushuri</user:PreferenceValueText>
               <user:PreferenceStatusText>Active</user:PreferenceStatusText>
               <user:PreferenceCreatedDate>2013-08-16</user:PreferenceCreatedDate>
               <user:DisplaySequence>1</user:DisplaySequence>
            </user:PreferenceDetail>
            <user:PreferenceDetail>
               <user:PreferenceType>Email</user:PreferenceType>
               <user:ApplicationAreaName>Monitoring</user:ApplicationAreaName>
               <user:PreferenceName>Mike-Email</user:PreferenceName>
               <user:PreferenceDescription>Mike's email address</user:PreferenceDescription>
               <user:PreferenceValueText>mike@mycompany.com</user:PreferenceValueText>
               <user:PreferenceStatusText>Active</user:PreferenceStatusText>
               <user:PreferenceCreatedDate>2013-08-16</user:PreferenceCreatedDate>
               <user:DisplaySequence>2</user:DisplaySequence>
            </user:PreferenceDetail>
         </user:ListPreferenceResponseDetail>
      </user:ListPreferenceResponse>
   </soap-env:Body>
</soapenv:Envelope>
Name Characteristics
ListPreferenceResponse Aggregate [M]
ListPreferenceResponse@ServiceVersionNumber Attribute [M]
ListPreferenceResponse. TransactionDetail Aggregate, Required [M]
ListPreferenceResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional [M]
ListPreferenceResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required [M]
ListPreferenceResponse. TransactionDetail. TransactionTimestamp DateTimestamp, Required [M]
END: ListPreferenceResponse. TransactionDetail /Aggregate [M]
ListPreferenceResponse. TransactionResult Aggregate, Required [M]
ListPreferenceResponse. TransactionResult. SeverityText string, Required [M]
ListPreferenceResponse. TransactionResult. ResultID string up to 32 chars., Required [M]
ListPreferenceResponse. TransactionResult. ResultText string up to 512 chars., Optional [M]
ListPreferenceResponse. TransactionResult. ResultMessage Aggregate, Optional (Array) [M]
ListPreferenceResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required [M]
END: ListPreferenceResponse. TransactionResult. ResultMessage /Aggregate [M]
END: ListPreferenceResponse. TransactionResult /Aggregate [M]
ListPreferenceResponse. ListPreferenceResponseDetail Aggregate, Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. CandidateMatchedQuantity int up to 6 digits., Required [M]

The number of registrations listed as possible matches in the result set based on the search criteria in the Customer/User request.

ListPreferenceResponse. ListPreferenceResponseDetail. CandidateReturnedQuantity int up to 6 digits., Required [M]

The number of registrations returned in the result set based on the search criteria in the Customer/User request.

ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail Aggregate, Optional (Array) [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceType PreferenceTypeEnum, Required [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. ApplicationAreaName ApplicationAreaEnum, Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceName string up to 64 chars., Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceDescription string up to 256 chars., Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceValueText string up to 256 chars., Required [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. UserCredentials Aggregate, Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. UserCredentials. UserID string up to 64 chars., Required [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. UserCredentials. PasswordText string up to 64 chars., Required [M]
END: ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. UserCredentials /Aggregate [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceStatusText PreferenceStatusTextEnum, Required [M]

Records the status of the monitoring profile

ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceCreatedDate date, Required [M]

Records the start date of the date range to list the Monitoring profiles

ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceCreatedDate@DatePrecisionText Attribute [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceCreatedDate@DatePrecisionDNBCodeValue Attribute [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. PreferenceCreatedDate@DatePrecisionDNBCodeTableNumber Attribute [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. DefaultPreference boolean, Optional [M]
ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail. DisplaySequence int up to 3 digits., Optional [M]

Records the display sequence number of the results

END: ListPreferenceResponse. ListPreferenceResponseDetail. PreferenceDetail /Aggregate [M]
END: ListPreferenceResponse. ListPreferenceResponseDetail /Aggregate [M]
END: ListPreferenceResponse /Aggregate [M]

NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM002, CM004, CM018, and SC001-SC009.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.