Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - accountBasicDetailsType

  • Article
  • 1 minutes to read

Description

This type is used to represent account basic details.

Properties

Name Type Occurrence Description
userId accountIdType Required The user identifier.
urn xs:anyURI Required URI referencing the user.
firstName xs:string Optional The first name of the user.
lastName xs:string Optional The last name of the user.
name nameType Required The display name of the user.
email xs:string Optional The users primary e-mail address.
onLineNow xs:boolean Optional This is set to true of the user is currently logged into the system.
icon xs:anyURI Optional The icon reference for this user.
lastKnownLocation geoLocationType Optional The last known location of the user.
onlineStatus onlineStatusType Required This is set to true of the user is currently logged into the system.
accountStatus accountStatusType Required Current status of the account.
availabilityStatusInfo availabilityStatusInfoType Optional The availability status of the user.
jobTitle xs:string Optional The job title of the user.
loginId accountIdType Optional The login ID for the user (Not applicable for update).
employeeId accountIdType Optional The employee ID for the user (Not applicable for update).
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document