{"id":5411,"date":"2022-11-14T17:17:48","date_gmt":"2022-11-14T17:17:48","guid":{"rendered":"https:\/\/serviceobjects.wpaladdin.com\/?page_id=5411"},"modified":"2022-12-14T22:08:21","modified_gmt":"2022-12-14T22:08:21","slug":"ur-errors","status":"publish","type":"page","link":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/","title":{"rendered":"UR &#8211; Errors"},"content":{"rendered":"\n<ul class=\"is-style-bullets-list wp-block-list\">\n<li><a href=\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#UR-Errors-ErrorCode1%E2%80%93%22Inputcannotbelessthanzerolength%22\">Error Code 1 \u2013 &#8220;Input cannot be less than zero length&#8221;<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#UR-Errors-ErrorCode2%E2%80%93Variousdescriptions\">Error Code 2 \u2013 Various descriptions<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#UR-Errors-ErrorCode3\/4\/5%E2%80%93Variousdescriptions\">Error Code 3\/4\/5 \u2013 Various descriptions<\/a><\/li>\n<\/ul>\n\n\n\n<p>Generally, an error is anything that happens during execution of DOTS&nbsp;Usage Reports&nbsp;that causes the service to fail. The source of these errors may be user input, license key transaction limits, timeouts, and unexpected circumstances.&nbsp;<strong>Applications should expect and handle any and all errors appropriately.<\/strong>&nbsp;Occasionally, new error types or descriptions may be introduced to the web service as new features and data sources are implemented. Description strings may change slightly, so use the description code to determine which error has occurred. Errors are organized into types, listed in the table below.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>The Error object appears under the main return object. Below is an example of the error returned when the&nbsp;<a href=\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-operations\/ur-getdotstransactiondetailsbydaterange-recommended\/\">GetDOTSTransactionDetailsByDateRange&nbsp;<\/a>operation is accessed without a valid license key.<\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p><strong>Example:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table class=\"has-fixed-layout\"><tbody><tr><td><code>&lt;<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>ReportTransactionDetailUsage<\/strong><\/mark>&gt;<\/code><br><code>&lt;<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Error<\/strong><\/mark>&gt;<\/code><br><code>&lt;<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Desc<\/strong><\/mark>&gt;License key and e-mail do not match our records.&lt;\/<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Desc<\/strong><\/mark>&gt;<\/code><br><code>&lt;<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Number<\/strong><\/mark>&gt;2&lt;\/<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Number<\/strong><\/mark>&gt;<\/code><br><code>&lt;\/<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>Error<\/strong><\/mark>&gt;<\/code><br><code>&lt;\/<mark style=\"color:#336699\" class=\"has-inline-color\"><strong>ReportTransactionDetailUsage<\/strong><\/mark>&gt;<\/code><\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">Error codes in Usage Reports are the same for all operations.<\/figcaption><\/figure>\n\n\n\n<p class=\"has-medium-font-size\" id=\"UR-Errors-ErrorCode1%E2%80%93%22Inputcannotbelessthanzerolength%22\">Error Code 1 \u2013 &#8220;Input cannot be less than zero length&#8221;<\/p>\n\n\n\n<div style=\"height:30px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li>This error means the web service did not get any input. The connection to the service was made, and data was transferred, but no parameters were passed that the service could understand.&nbsp;<\/li>\n\n\n\n<li>This error often happens when the input is passed to the service with namespaces that the service does not understand. Applying a namespace to any of the parameters (Address, City, State, etc.) will cause this error. Additionally, requests made in the &#8220;rpc\/encoded&#8221; format will cause this error. The only namespace that should appear in any element is the &#8220;<a rel=\"noreferrer noopener\" href=\"https:\/\/www.serviceobjects.com\/\" target=\"_blank\">https:\/\/www.serviceobjects.com<\/a>&#8221; namespace on the root Validate* element as so:<\/li>\n<\/ul>\n\n\n\n<div style=\"height:30px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table class=\"has-fixed-layout\"><tbody><tr><td><code>&lt;<\/code><strong><code><mark style=\"color:#336699\" class=\"has-inline-color\">ReportTransactionDetailUsage<\/mark><\/code>&nbsp;<\/strong><code>xmlns=\"<a href=\"https:\/\/www.serviceobjects.com\/\">https:\/\/www.serviceobjects.com\/<\/a>\"&gt;<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li><strong>Note, however, that the namespace is not applied to the ReportTransactionDetailUsage element, it is only present.<\/strong><\/li>\n<\/ul>\n\n\n\n<div style=\"height:30px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"UR-Errors-ErrorCode2\u2013Variousdescriptions\">Error Code 2 \u2013 Various descriptions<\/h2>\n\n\n\n<div style=\"height:30px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li>This error code appears when various errors occur but are of the expected nature. Oftentimes, maligned or incomplete input will cause an error 2.&nbsp;<br>The following is a list of the possible Error Descriptions that may accompany an Error Code 2:<\/li>\n<\/ul>\n\n\n\n<div style=\"height:50px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li><em>Bad or Incomplete GETDOTSTransaction Errors<\/em><\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-table is-style-table-section\"><table><thead><tr><th scope=\"col\">Description<\/th><\/tr><\/thead><tbody><tr><td>License Key is required.<\/td><\/tr><tr><td>Email is required.<\/td><\/tr><tr><td>License key and email do not match our records.<\/td><\/tr><tr><td>A valid Date is required.<\/td><\/tr><tr><td>Please enter a valid date range.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li><em>Failed Authentication Errors:<\/em><\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-table is-style-table-section\"><table><thead><tr><th scope=\"col\">Description<\/th><\/tr><\/thead><tbody><tr><td>Please provide a valid license key for this web service.<\/td><\/tr><tr><td>This license key has expired.<\/td><\/tr><tr><td>This license key has not yet been activated.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li><em>Web Service Invocation Errors:<\/em><\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-table is-style-table-section\"><table><thead><tr><th scope=\"col\">Description<\/th><\/tr><\/thead><tbody><tr><td>Error initializing service.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"UR-Errors-ErrorCode3\/4\/5\u2013Variousdescriptions\">Error Code 3\/4\/5 \u2013 Various descriptions<\/h2>\n\n\n\n<ul class=\"is-style-no-bullets-indented-list wp-block-list\">\n<li>An error code 3, 4, or 5 is a fatal error and it means something serious has gone wrong. You will never see one of these error codes in a live production environment.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Generally, an error is anything that happens during execution of DOTS&nbsp;Usage Reports&nbsp;that causes the service to fail. The source of these errors may be user input, license key transaction limits, timeouts, and unexpected circumstances.&nbsp;Applications should expect and handle any and all errors appropriately.&nbsp;Occasionally, new error types or descriptions may be introduced to the web service [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":5395,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-5411","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.7 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>UR - Errors<\/title>\n<meta name=\"description\" content=\"Error Code 1 \u2013 &quot;Input cannot be less than zero length&quot; Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is\" \/>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"UR - Errors\" \/>\n<meta property=\"og:description\" content=\"Error Code 1 \u2013 &quot;Input cannot be less than zero length&quot; Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is\" \/>\n<meta property=\"og:url\" content=\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/\" \/>\n<meta property=\"og:site_name\" content=\"Service Objects | Contact, Phone, Email Verification | Data Quality Services\" \/>\n<meta property=\"article:modified_time\" content=\"2022-12-14T22:08:21+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/\",\"url\":\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/\",\"name\":\"UR - Errors\",\"isPartOf\":{\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#website\"},\"datePublished\":\"2022-11-14T17:17:48+00:00\",\"dateModified\":\"2022-12-14T22:08:21+00:00\",\"description\":\"Error Code 1 \u2013 \\\"Input cannot be less than zero length\\\" Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is\",\"breadcrumb\":{\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/test.serviceobjects.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"DOTS Usage Report\",\"item\":\"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"UR &#8211; Errors\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#website\",\"url\":\"https:\/\/test.serviceobjects.com\/docs\/\",\"name\":\"Service Objects | Contact, Phone, Email Verification | Data Quality Services\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/test.serviceobjects.com\/docs\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#organization\",\"name\":\"Service Objects | Contact, Phone, Email Verification | Data Quality Services\",\"url\":\"https:\/\/test.serviceobjects.com\/docs\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/test.serviceobjects.com\/docs\/wp-content\/uploads\/2022\/08\/SO-logo-2560px-transparent.png\",\"contentUrl\":\"https:\/\/test.serviceobjects.com\/docs\/wp-content\/uploads\/2022\/08\/SO-logo-2560px-transparent.png\",\"width\":2560,\"height\":1440,\"caption\":\"Service Objects | Contact, Phone, Email Verification | Data Quality Services\"},\"image\":{\"@id\":\"https:\/\/test.serviceobjects.com\/docs\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"UR - Errors","description":"Error Code 1 \u2013 \"Input cannot be less than zero length\" Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"en_US","og_type":"article","og_title":"UR - Errors","og_description":"Error Code 1 \u2013 \"Input cannot be less than zero length\" Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is","og_url":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/","og_site_name":"Service Objects | Contact, Phone, Email Verification | Data Quality Services","article_modified_time":"2022-12-14T22:08:21+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/","url":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/","name":"UR - Errors","isPartOf":{"@id":"https:\/\/test.serviceobjects.com\/docs\/#website"},"datePublished":"2022-11-14T17:17:48+00:00","dateModified":"2022-12-14T22:08:21+00:00","description":"Error Code 1 \u2013 \"Input cannot be less than zero length\" Error Code 2 \u2013 Various descriptions Error Code 3\/4\/5 \u2013 Various descriptions Generally, an error is","breadcrumb":{"@id":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/ur-errors\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/test.serviceobjects.com\/docs\/"},{"@type":"ListItem","position":2,"name":"DOTS Usage Report","item":"https:\/\/test.serviceobjects.com\/docs\/dots-usage-report\/"},{"@type":"ListItem","position":3,"name":"UR &#8211; Errors"}]},{"@type":"WebSite","@id":"https:\/\/test.serviceobjects.com\/docs\/#website","url":"https:\/\/test.serviceobjects.com\/docs\/","name":"Service Objects | Contact, Phone, Email Verification | Data Quality Services","description":"","publisher":{"@id":"https:\/\/test.serviceobjects.com\/docs\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/test.serviceobjects.com\/docs\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/test.serviceobjects.com\/docs\/#organization","name":"Service Objects | Contact, Phone, Email Verification | Data Quality Services","url":"https:\/\/test.serviceobjects.com\/docs\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/test.serviceobjects.com\/docs\/#\/schema\/logo\/image\/","url":"https:\/\/test.serviceobjects.com\/docs\/wp-content\/uploads\/2022\/08\/SO-logo-2560px-transparent.png","contentUrl":"https:\/\/test.serviceobjects.com\/docs\/wp-content\/uploads\/2022\/08\/SO-logo-2560px-transparent.png","width":2560,"height":1440,"caption":"Service Objects | Contact, Phone, Email Verification | Data Quality Services"},"image":{"@id":"https:\/\/test.serviceobjects.com\/docs\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/pages\/5411","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/comments?post=5411"}],"version-history":[{"count":15,"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/pages\/5411\/revisions"}],"predecessor-version":[{"id":7926,"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/pages\/5411\/revisions\/7926"}],"up":[{"embeddable":true,"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/pages\/5395"}],"wp:attachment":[{"href":"https:\/\/test.serviceobjects.com\/docs\/wp-json\/wp\/v2\/media?parent=5411"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}