{"id":24348,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getuserbyemail-1\/"},"modified":"2025-02-17T12:24:38","modified_gmt":"2025-02-17T20:24:38","slug":"getuserbyemail-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/","title":{"rendered":"getUserByEmail"},"content":{"rendered":"

This action retrieves the first found user within ExtraView for a given email address. Note that if the same email address is used for different users, only the first is returned.<\/p>\n

\n\tInput<\/h3>\n\n\n\n\n\n\n
\n

Class<\/p>\n<\/td>\n

\n

Name<\/p>\n<\/td>\n

\n

Type<\/p>\n<\/td>\n

\n

Required<\/p>\n<\/td>\n

\n

Details<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailRequest<\/p>\n<\/td>\n

\n

userId<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Yes<\/p>\n<\/td>\n

\n

The callers user name<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailRequest<\/p>\n<\/td>\n

\n

password<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Yes<\/p>\n<\/td>\n

\n

The callers password<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailRequest<\/p>\n<\/td>\n

\n

email<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Yes<\/p>\n<\/td>\n

\n

The email address of the user your getting<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tOutput<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Class<\/p>\n<\/td>\n

\n

Name<\/p>\n<\/td>\n

\n

Type<\/p>\n<\/td>\n

\n

Required<\/p>\n<\/td>\n

\n

Details<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailResponse<\/p>\n<\/td>\n

\n

success<\/p>\n<\/td>\n

\n

boolean<\/p>\n<\/td>\n

\n

Yes<\/p>\n<\/td>\n

\n

True is succeeded False if failed<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailResponse<\/p>\n<\/td>\n

\n

returnCode<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

See Appendix for details<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailResponse<\/p>\n<\/td>\n

\n

returnMessage<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

Human readable message<\/p>\n<\/td>\n<\/tr>\n

\n

GetUserByEmailResponse<\/p>\n<\/td>\n

\n

user<\/p>\n<\/td>\n

\n

Object<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

A Single UserBean Object<\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

userId<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Yes<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

userPassword<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

firstName<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

lastName<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

password<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

email<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

jobTitle<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

companyName<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

addressLine1<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

addressLine2<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

city<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

state<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

postalCode<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

country<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

workPhoneNumber<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

homePhoneNumber<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

cellPhoneNumber<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

faxNumber<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n

\n

UserBean<\/p>\n<\/td>\n

\n

pagerNumber<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

No<\/p>\n<\/td>\n

\n

 <\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tExample<\/h3>\n

public static void testGetUserByEmail(EVUserServiceStub stub) {
\n\t    try {
\n\t        GetUserByEmailDocument reqEnvelope = GetUserByEmailDocument.Factory.newInstance();
\n\t        GetUserByEmailRequest request = reqEnvelope.addNewGetUserByEmail().addNewRequest();
\n\t        request.setEmail(ServiceClientHelper.generatedEmail);
\n\t        request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
\n\t        request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
\n\t        GetUserByEmailResponseDocument resEnvelope = stub.getUserByEmail(reqEnvelope);
\n\t        GetUserByEmailResponse response =
\n\t            resEnvelope.getGetUserByEmailResponse().getReturn();
\n\t        if (response.getSuccess()) {
\n\t            System.out.println(\"success: [\" + response.getReturnCode() + \"] : \" +
\n\t                                              response.getReturnMessage());
\n\t        } else {
\n\t            System.out.println(\"failure: [\" + response.getReturnCode() + \"] : \" +
\n\t                                              response.getReturnMessage());
\n\t        }
\n\t    } catch (Exception e) {
\n\t        e.printStackTrace();
\n\t        System.err.println(\"nnn\");
\n\t    }
\n\t}<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"

This action retrieves the first found user within ExtraView for a given email address. Note that if the same email address is used for different users, only the first is returned. Input Class Name Type Required Details GetUserByEmailRequest userId String Yes The callers user name GetUserByEmailRequest password String Yes The callers password GetUserByEmailRequest email String…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24321,"menu_order":42,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24348","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\ngetUserByEmail - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"getUserByEmail - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This action retrieves the first found user within ExtraView for a given email address. Note that if the same email address is used for different users, only the first is returned. Input Class Name Type Required Details GetUserByEmailRequest userId String Yes The callers user name GetUserByEmailRequest password String Yes The callers password GetUserByEmailRequest email String...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T20:24:38+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:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/\",\"name\":\"getUserByEmail - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T20:24:38+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Web Services Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"getUserByEmail\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"getUserByEmail - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/","og_locale":"en_US","og_type":"article","og_title":"getUserByEmail - Product Documentation","og_description":"This action retrieves the first found user within ExtraView for a given email address. Note that if the same email address is used for different users, only the first is returned. Input Class Name Type Required Details GetUserByEmailRequest userId String Yes The callers user name GetUserByEmailRequest password String Yes The callers password GetUserByEmailRequest email String...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T20:24:38+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/","name":"getUserByEmail - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T20:24:38+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getuserbyemail-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Web Services Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/"},{"@type":"ListItem","position":4,"name":"getUserByEmail"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24348","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24348"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24348\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24321"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24348"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}