# XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]
Schema Component Representation:
[ Expand All | Collapse All ]

## Table of Contents

- Schema Document Properties
- Global Definitions
  - Complex Type: AuthenticationRequest
  - Complex Type: AuthenticationResponse
  - Complex Type: AuthenticationVerifyRequest14sp8
  - Complex Type: AuthenticationVerifyResponse14sp8
  - Complex Type: AvailabilityTestRequest
  - Complex Type: DeviceManagementFileAuthLocationGetRequest18
  - Complex Type: DeviceManagementFileAuthLocationGetResponse18
  - Complex Type: DeviceManagementPutFileRequest
  - Complex Type: ExternalAuthenticationAuthorizeTokenRequest
  - Complex Type: ExternalAuthenticationCreateLoginTokenRequest
  - Complex Type: ExternalAuthenticationCreateLoginTokenResponse
  - Complex Type: LoginRequest14sp4
  - Complex Type: LoginResponse14sp4
  - Complex Type: LogoutRequest
  - Complex Type: PasswordModifyRequest
  - Complex Type: PrimaryInfoGetRequest
  - Complex Type: PrimaryInfoGetResponse
  - Complex Type: PublicClusterGetFullyQualifiedDomainNameRequest
  - Complex Type: PublicClusterGetFullyQualifiedDomainNameResponse
  - Complex Type: TutorialFlagGetRequest
  - Complex Type: TutorialFlagGetResponse
  - Complex Type: TutorialFlagModifyRequest
  - Complex Type: UserGetLoginInfoRequest
  - Complex Type: UserGetLoginInfoResponse
  - Complex Type: VerifySessionIsValidRequest
  - Simple Type: LogoutRequestReason

- Legend

- Glossary

top

## Schema Document Properties

Target Namespace | None
Element and Attribute Namespaces | Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations belong to this schema's target namespace.
Schema Composition | This schema imports schema(s) from the following namespace(s): C (at OCISchemaBASE.xsd) This schema includes components from the following schema document(s): OCISchemaDataTypes.xsd

### Declared Namespaces

Prefix | Namespace
--- | ---
Default namespace |
xml | http://www.w3.org/XML/1998/namespace
xs | http://www.w3.org/2001/XMLSchema
core | C

Schema Component Representation
<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:import namespace="C" schemaLocation="OCISchemaBASE.xsd"/>
<xs:include schemaLocation="OCISchemaDataTypes.xsd"/>
...
</xs:schema>
top

## Global Definitions

### Complex Type: AuthenticationRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | AuthenticationRequest
Abstract | no
Documentation | AuthenticationRequest is 1st stage of the 2 stage OCI login process.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="AuthenticationRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: AuthenticationResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | AuthenticationResponse
Abstract | no
Documentation | AuthenticationRequest/Response is 1st stage of the 2 stage OCI login process.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<nonce> xs:string </nonce> [1]
<passwordAlgorithm> DigitalSignatureAlgorithm </passwordAlgorithm> [1]
</...>
Schema Component Representation
<xs:complexType name="AuthenticationResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="nonce" type=" xs:string "/>
<xs:element name="passwordAlgorithm" type=" DigitalSignatureAlgorithm "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: AuthenticationVerifyRequest14sp8

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | AuthenticationVerifyRequest14sp8
Abstract | no
Documentation | AuthenticationVerifyRequest14sp8 is used to authenticate a user either by userId/password, userId/sip username/sip password, dn/passcode or a token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest. The phone number may be any DN associated with a user. The response is a AuthenticationVerifyResponse14sp8 or an ErrorResponse

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
Start Choice [1]
<userId> UserId </userId> [1]
<password> Password </password> [1]
<phoneNumber> DN </phoneNumber> [1]
<passcode> Passcode </passcode> [1]
<loginToken> LoginToken </loginToken> [1]
<sipAuthenticationUserName> SIPAuthenticationUserName </sipAuthenticationUserName> [1]
<sipAuthenticationPassword> SIPAuthenticationPassword </sipAuthenticationPassword> [1]
<userId> UserId </userId> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="AuthenticationVerifyRequest14sp8">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:choice>
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="password" type=" Password "/>
</xs:sequence>
<xs:sequence>
<xs:element name="phoneNumber" type=" DN "/>
<xs:element name="passcode" type=" Passcode "/>
</xs:sequence>
<xs:sequence>
<xs:element name="loginToken" type=" LoginToken "/>
</xs:sequence>
<xs:sequence>
<xs:element name="sipAuthenticationUserName" type=" SIPAuthenticationUserName "/>
<xs:element name="sipAuthenticationPassword" type=" SIPAuthenticationPassword "/>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:choice>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: AuthenticationVerifyResponse14sp8

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | AuthenticationVerifyResponse14sp8
Abstract | no
Documentation | Response to AuthenticationVerifyRequest14sp8 If a phoneNumber is returned, it will be the primay DN of the user

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<loginType> LoginType </loginType> [1]
<locale> OCILocale </locale> [1]
<encoding> Encoding </encoding> [1]
<groupId> GroupId </groupId> [0..1]
<serviceProviderId> ServiceProviderId </serviceProviderId> [0..1]
<isEnterprise> xs:boolean </isEnterprise> [1]
<passwordExpiresDays> xs:int </passwordExpiresDays> [0..1]
<lastName> LastName </lastName> [0..1]
<firstName> FirstName </firstName> [0..1]
<userId> UserId </userId> [1]
<phoneNumber> DN </phoneNumber> [0..1]
</...>
Schema Component Representation
<xs:complexType name="AuthenticationVerifyResponse14sp8">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="loginType" type=" LoginType "/>
<xs:element name="locale" type=" OCILocale "/>
<xs:element name="encoding" type=" Encoding "/>
<xs:element name="groupId" type=" GroupId " minOccurs="0"/>
<xs:element name="serviceProviderId" type=" ServiceProviderId " minOccurs="0"/>
<xs:element name="isEnterprise" type=" xs:boolean "/>
<xs:element name="passwordExpiresDays" type=" xs:int " minOccurs="0"/>
<xs:element name="lastName" type=" LastName " minOccurs="0"/>
<xs:element name="firstName" type=" FirstName " minOccurs="0"/>
<xs:element name="userId" type=" UserId "/>
<xs:element name="phoneNumber" type=" DN " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: AvailabilityTestRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | AvailabilityTestRequest
Abstract | no
Documentation | AvailabilityTestRequest is for high-availability support. Response is either SuccessResponse or ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<xs:complexType name="AvailabilityTestRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: DeviceManagementFileAuthLocationGetRequest18

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | DeviceManagementFileAuthLocationGetRequest18
Abstract | no
Documentation | Get the address and credentials of the File Repository hosting the requested access device file. Also get the file name and path on the File Repository. The response is either a DeviceManagementFileAuthLocationGetResponse18 or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<deviceAccessProtocol> DeviceAccessProtocol16 </deviceAccessProtocol> [1]
<deviceAccessMethod> FileRepositoryAccessType </deviceAccessMethod> [1]
<deviceAccessURI> DeviceManagementAccessURI </deviceAccessURI> [1]
<accessDeviceUserName> UserId </accessDeviceUserName> [0..1]
<accessDeviceUserPassword> Password </accessDeviceUserPassword> [0..1]
<signedPassword> SignedPassword </signedPassword> [0..1]
<macAddress> AccessDeviceMACAddress </macAddress> [0..1]
<realmName> RealmName </realmName> [0..1]
<digestHa1Complement> DigestHa1Complement </digestHa1Complement> [0..1]
<digestResponse> Md5Hash </digestResponse> [0..1]
</...>
Schema Component Representation
<xs:complexType name="DeviceManagementFileAuthLocationGetRequest18">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="deviceAccessProtocol" type=" DeviceAccessProtocol16 "/>
<xs:element name="deviceAccessMethod" type=" FileRepositoryAccessType "/>
<xs:element name="deviceAccessURI" type=" DeviceManagementAccessURI "/>
<xs:element name="accessDeviceUserName" type=" UserId " minOccurs="0"/>
<xs:element name="accessDeviceUserPassword" type=" Password " minOccurs="0"/>
<xs:element name="signedPassword" type=" SignedPassword " minOccurs="0"/>
<xs:element name="macAddress" type=" AccessDeviceMACAddress " minOccurs="0"/>
<xs:element name="realmName" type=" RealmName " minOccurs="0"/>
<xs:element name="digestHa1Complement" type=" DigestHa1Complement " minOccurs="0"/>
<xs:element name="digestResponse" type=" Md5Hash " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: DeviceManagementFileAuthLocationGetResponse18

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | DeviceManagementFileAuthLocationGetResponse18
Abstract | no
Documentation | Return the address and credentials of the File Repository hosting the requested access device file. Also return the file name and path on the File Repository. This is a response to DeviceManagementFileAuthLocationGetRequest18.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<fileRepositoryUserName> FileRepositoryUserName </fileRepositoryUserName> [1]
<fileRepositoryPassword> FileRepositoryUserPassword </fileRepositoryPassword> [1]
<netAddress> NetAddress </netAddress> [1]
<remoteFileFormat> DeviceManagementFileFormat </remoteFileFormat> [1]
<portNumber> Port </portNumber> [0..1]
<rootDirectory> CPEFileDirectory </rootDirectory> [0..1]
<cpeFileDirectory> CPEFileDirectory </cpeFileDirectory> [0..1]
<secure> xs:boolean </secure> [0..1]
<macInNonRequestURI> xs:boolean </macInNonRequestURI> [0..1]
<macFormatInNonRequestURI> DeviceManagementAccessURI </macFormatInNonRequestURI> [0..1]
<useHttpDigestAuthentication> xs:boolean </useHttpDigestAuthentication> [0..1]
<macBasedFileAuthentication> xs:boolean </macBasedFileAuthentication> [0..1]
<userNamePasswordFileAuthentication> xs:boolean </userNamePasswordFileAuthentication> [0..1]
<completionNotification> xs:boolean </completionNotification> [0..1]
<fileCategory> DeviceManagementFileCategory </fileCategory> [0..1]
<enableCaching> xs:boolean </enableCaching> [0..1]
</...>
Schema Component Representation
<xs:complexType name="DeviceManagementFileAuthLocationGetResponse18">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="fileRepositoryUserName" type=" FileRepositoryUserName "/>
<xs:element name="fileRepositoryPassword" type=" FileRepositoryUserPassword "/>
<xs:element name="netAddress" type=" NetAddress "/>
<xs:element name="remoteFileFormat" type=" DeviceManagementFileFormat "/>
<xs:element name="portNumber" type=" Port " minOccurs="0"/>
<xs:element name="rootDirectory" type=" CPEFileDirectory " minOccurs="0"/>
<xs:element name="cpeFileDirectory" type=" CPEFileDirectory " minOccurs="0"/>
<xs:element name="secure" type=" xs:boolean " minOccurs="0"/>
<xs:element name="macInNonRequestURI" type=" xs:boolean " minOccurs="0"/>
<xs:element name="macFormatInNonRequestURI" type=" DeviceManagementAccessURI " minOccurs="0"/>
<xs:element name="useHttpDigestAuthentication" type=" xs:boolean " minOccurs="0"/>
<xs:element name="macBasedFileAuthentication" type=" xs:boolean " minOccurs="0"/>
<xs:element name="userNamePasswordFileAuthentication" type=" xs:boolean " minOccurs="0"/>
<xs:element name="completionNotification" type=" xs:boolean " minOccurs="0"/>
<xs:element name="fileCategory" type=" DeviceManagementFileCategory " minOccurs="0"/>
<xs:element name="enableCaching" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: DeviceManagementPutFileRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | DeviceManagementPutFileRequest
Abstract | no
Documentation | Informs BroadWorks that a file was uploaded to the repository. The response is always a SuccessResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<deviceAccessURI> DeviceManagementAccessURI </deviceAccessURI> [1]
<ipAddress> NetAddress </ipAddress> [1]
</...>
Schema Component Representation
<xs:complexType name="DeviceManagementPutFileRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="deviceAccessURI" type=" DeviceManagementAccessURI "/>
<xs:element name="ipAddress" type=" NetAddress "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: ExternalAuthenticationAuthorizeTokenRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | ExternalAuthenticationAuthorizeTokenRequest
Abstract | no
Documentation | This command is part of the Portal API. Sent when a Web or CLI user logs in using external authentication. The password must be hashed. The password hashing algorithm is: 1) The message digest of the user's plain password is calculated using the SHA algorithm. 2) For every four bits in the 160-bit digest, starting from the first bit, it is converted into a character in ASCII Hex format (0 through 9, a through f). The result is a 40-character string, for example, f7a9e24777ec23212c54d7a350bc5bea5477fdbb. 3) The above string then is used to populate the password field in the request. The response is either SuccessResponse or ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<password> Password </password> [0..1]
<loginToken> LoginToken </loginToken> [1]
</...>
Schema Component Representation
<xs:complexType name="ExternalAuthenticationAuthorizeTokenRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="password" type=" Password " minOccurs="0"/>
<xs:element name="loginToken" type=" LoginToken "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: ExternalAuthenticationCreateLoginTokenRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | ExternalAuthenticationCreateLoginTokenRequest
Abstract | no
Documentation | This command allows a BroadWorks or Third-Party Client Application to create a Single Sign-On token for a user. The response is either ExternalAuthenticationCreateLoginTokenResponse or ErrorResponse.
Application Data | `<asDataModeSupported> true </asDataModeSupported>` `<hssDataModeSupported> false </hssDataModeSupported>`

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="ExternalAuthenticationCreateLoginTokenRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: ExternalAuthenticationCreateLoginTokenResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | ExternalAuthenticationCreateLoginTokenResponse
Abstract | no
Documentation | Response to ExternalAuthenticationCreateLoginTokenRequest.
Application Data | `<asDataModeSupported> true </asDataModeSupported>` `<hssDataModeSupported> false </hssDataModeSupported>`

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<loginToken> LoginToken </loginToken> [1]
</...>
Schema Component Representation
<xs:complexType name="ExternalAuthenticationCreateLoginTokenResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="loginToken" type=" LoginToken "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: LoginRequest14sp4

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | LoginRequest14sp4
Abstract | no
Documentation | LoginRequest14sp4 is 2nd stage of the 2 stage OCI login process. The signedPassword is not required for external authentication login from a trusted host (ACL).

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<signedPassword> SignedPassword </signedPassword> [0..1]
<plainTextPassword> Password </plainTextPassword> [0..1]
</...>
Schema Component Representation
<xs:complexType name="LoginRequest14sp4">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="signedPassword" type=" SignedPassword " minOccurs="0"/>
<xs:element name="plainTextPassword" type=" Password " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: LoginResponse14sp4

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | LoginResponse14sp4
Abstract | no
Documentation | LoginRequest14sp4/Response14sp4 is 2nd stage of the 2 stage OCI login process.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<loginType> LoginType </loginType> [1]
<locale> OCILocale </locale> [1]
<encoding> Encoding </encoding> [1]
<groupId> GroupId </groupId> [0..1]
<serviceProviderId> ServiceProviderId </serviceProviderId> [0..1]
<isEnterprise> xs:boolean </isEnterprise> [1]
<passwordExpiresDays> xs:int </passwordExpiresDays> [0..1]
<userDomain> NetAddress </userDomain> [1]
</...>
Schema Component Representation
<xs:complexType name="LoginResponse14sp4">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="loginType" type=" LoginType "/>
<xs:element name="locale" type=" OCILocale "/>
<xs:element name="encoding" type=" Encoding "/>
<xs:element name="groupId" type=" GroupId " minOccurs="0"/>
<xs:element name="serviceProviderId" type=" ServiceProviderId " minOccurs="0"/>
<xs:element name="isEnterprise" type=" xs:boolean "/>
<xs:element name="passwordExpiresDays" type=" xs:int " minOccurs="0"/>
<xs:element name="userDomain" type=" NetAddress "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: LogoutRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | LogoutRequest
Abstract | no
Documentation | LogoutRequest is sent when an OCI user logs out or when connection is lost. This command can be sent either to the server, or to the client from OCS. Response is either SuccessResponse or ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<reason> LogoutRequestReason </reason> [0..1]
</...>
Schema Component Representation
<xs:complexType name="LogoutRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="reason" type=" LogoutRequestReason " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: PasswordModifyRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | PasswordModifyRequest
Abstract | no
Documentation | Modify the password for a user/administrator. When oldPassword is specified, password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The response is either a SuccessResponse or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<oldPassword> Password </oldPassword> [0..1]
<newPassword> Password </newPassword> [1]
</...>
Schema Component Representation
<xs:complexType name="PasswordModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="oldPassword" type=" Password " minOccurs="0"/>
<xs:element name="newPassword" type=" Password "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: PrimaryInfoGetRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | PrimaryInfoGetRequest
Abstract | no
Documentation | Requests information about the primary server for high-availability support.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<isPrivate> xs:boolean </isPrivate> [1] ?
<isAddressInfoRequested> xs:boolean </isAddressInfoRequested> [1] ?
</...>
Schema Component Representation
<xs:complexType name="PrimaryInfoGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="isPrivate" type=" xs:boolean "/>
<xs:element name="isAddressInfoRequested" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: PrimaryInfoGetResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | PrimaryInfoGetResponse
Abstract | no
Documentation | Information about the primary server in the high-availablity cluster. For optimization, we only get the hostname and addresses for primary if they are explicitly requested or if the current server is not the primary.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<isPrimary> xs:boolean </isPrimary> [1] ?
<hostnameForPrimary> NetAddress </hostnameForPrimary> [0..1] ?
<addressForPrimary> NetAddress </addressForPrimary> [0..*] ?
<privateAddressForPrimary> NetAddress </privateAddressForPrimary> [0..*] ?
</...>
Schema Component Representation
<xs:complexType name="PrimaryInfoGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="isPrimary" type=" xs:boolean "/>
<xs:element name="hostnameForPrimary" type=" NetAddress " minOccurs="0"/>
<xs:element name="addressForPrimary" type=" NetAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="privateAddressForPrimary" type=" NetAddress " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: PublicClusterGetFullyQualifiedDomainNameRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | PublicClusterGetFullyQualifiedDomainNameRequest
Abstract | no
Documentation | Get the public cluster fully qualified domain name (FQDN). The response is either a PublicClusterGetFullyQualifiedDomainNameResponse or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<xs:complexType name="PublicClusterGetFullyQualifiedDomainNameRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: PublicClusterGetFullyQualifiedDomainNameResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | PublicClusterGetFullyQualifiedDomainNameResponse
Abstract | no
Documentation | Response to PublicClusterGetFullyQualifiedDomainNameRequest.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<publicClusterFQDN> DomainName </publicClusterFQDN> [0..1]
</...>
Schema Component Representation
<xs:complexType name="PublicClusterGetFullyQualifiedDomainNameResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="publicClusterFQDN" type=" DomainName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: TutorialFlagGetRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | TutorialFlagGetRequest
Abstract | no
Documentation | Get the tutorial flag setting for a user or admin. The response is either a TutorialFlagGetResponse or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="TutorialFlagGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: TutorialFlagGetResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | TutorialFlagGetResponse
Abstract | no
Documentation | Response to the TutorialFlagGetRequest.

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<enableTutorial> xs:boolean </enableTutorial> [1]
</...>
Schema Component Representation
<xs:complexType name="TutorialFlagGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="enableTutorial" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: TutorialFlagModifyRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | TutorialFlagModifyRequest
Abstract | no
Documentation | Modify the tutorial flag setting for a user or admin. The response is either a SuccessResponse or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<enableTutorial> xs:boolean </enableTutorial> [0..1]
</...>
Schema Component Representation
<xs:complexType name="TutorialFlagModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="enableTutorial" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: UserGetLoginInfoRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | UserGetLoginInfoRequest
Abstract | no
Documentation | UserGetLoginInfoRequest is used to access login information for a user either by a userId or dn. The phone number may be any DN associated with a user. The response is a UserGetLoginInfoResponse or an ErrorResponse

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
Start Choice [1]
<userId> UserId </userId> [1]
<phoneNumber> DN </phoneNumber> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="UserGetLoginInfoRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:choice>
<xs:element name="userId" type=" UserId "/>
<xs:element name="phoneNumber" type=" DN "/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: UserGetLoginInfoResponse

Parent type: | core:OCIDataResponse (derivation method: extension)
Sub-types: | None

Name | UserGetLoginInfoResponse
Abstract | no
Documentation | Response to UserGetLoginInfoRequest If a phoneNumber is returned, it will be the primay DN of the user

XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<loginType> LoginType </loginType> [1]
<locale> OCILocale </locale> [1]
<encoding> Encoding </encoding> [1]
<groupId> GroupId </groupId> [0..1]
<serviceProviderId> ServiceProviderId </serviceProviderId> [0..1]
<isEnterprise> xs:boolean </isEnterprise> [1]
<passwordExpiresDays> xs:int </passwordExpiresDays> [0..1]
<lastName> LastName </lastName> [0..1]
<firstName> FirstName </firstName> [0..1]
<userId> UserId </userId> [1]
<phoneNumber> DN </phoneNumber> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserGetLoginInfoResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="loginType" type=" LoginType "/>
<xs:element name="locale" type=" OCILocale "/>
<xs:element name="encoding" type=" Encoding "/>
<xs:element name="groupId" type=" GroupId " minOccurs="0"/>
<xs:element name="serviceProviderId" type=" ServiceProviderId " minOccurs="0"/>
<xs:element name="isEnterprise" type=" xs:boolean "/>
<xs:element name="passwordExpiresDays" type=" xs:int " minOccurs="0"/>
<xs:element name="lastName" type=" LastName " minOccurs="0"/>
<xs:element name="firstName" type=" FirstName " minOccurs="0"/>
<xs:element name="userId" type=" UserId "/>
<xs:element name="phoneNumber" type=" DN " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: VerifySessionIsValidRequest

Parent type: | core:OCIRequest (derivation method: extension)
Sub-types: | None

Name | VerifySessionIsValidRequest
Abstract | no
Documentation | Query the provisioning server to verify the session is authorized. Most applications should not need this command, because the provisioning server verifies the session is authorized for all commands. The response is either a SuccessResponse or an ErrorResponse.

XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<xs:complexType name="VerifySessionIsValidRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Simple Type: LogoutRequestReason

Parent type: | xs:token (derivation method: restriction)
Sub-types: | None

Name | LogoutRequestReason
Content | Base XSD Type: token value comes from list: {'Client Logout'|'Server Connection Failure'|'Open Client Server Forced Logout'}
Documentation | Logout request reason.

Schema Component Representation
<xs:simpleType name="LogoutRequestReason">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Client Logout"/>
<xs:enumeration value="Server Connection Failure"/>
<xs:enumeration value="Open Client Server Forced Logout"/>
</xs:restriction>
</xs:simpleType>
top

## Legend

### Complex Type:

Schema Component Type

### AusAddress

Schema Component Name

Parent type: | Address (derivation method: extension)
Sub-types: | QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name | AusAddress
Abstract | no

The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
  - If the element/attribute's type is in the schema, a link is provided to it.
  - For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

## Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an `xsi:type` attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the `xsi:nil` attribute. The `xsi:nil` attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an `xsi:nil` attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top