5.7.3.2 Parameters
Table 17 defines the parameters for the Service.
| Name | Type | Description |
|---|---|---|
| Request | ||
requestHeader | RequestHeader | Common request parameters. The type RequestHeader is defined in 7.32. |
clientSignature | SignatureData | This is a signature calculated using the method in 6.1.8. The SignatureData type is defined in 7.36. |
clientSoftwareCertificates [] | SignedSoftwareCertificate | Reserved for future use. The SignedSoftwareCertificate type is defined in 7.37. |
localeIds [] | LocaleId | List of locale ids to use. See locale negotiation in 5.4 which applies to this Service. This parameter only needs to be specified during the first call to ActivateSession during a single application Session. If it is null or empty the Server shall keep using the current localeIds for the Session. |
userIdentityToken | Extensible Parameter UserIdentityToken | The credentials of the user associated with the Client application. The Server uses these credentials to determine whether the Client should be allowed to activate a Session and what resources the Client has access to during this Session. The UserIdentityToken is an extensible parameter type defined in 7.40. The EndpointDescription specifies what UserIdentityTokens the Server shall accept. Null or empty user token shall always be interpreted as anonymous. |
userTokenSignature | SignatureData | If the Client specified a user identity token that supports digital signatures, then it shall create a signature and pass it as this parameter. Otherwise the parameter is null or empty. This is a signature calculated using the method in 6.1.8. The SignatureData type is defined in 7.36. |
| Response | ||
|---|---|---|
responseHeader | ResponseHeader | Common response parameters (see 7.33 for ResponseHeader definition). |
serverNonce | ByteString | A random number that should never be used in any other request. This number shall have a length between 32 and 128 bytes inclusive. The Client shall check the length. The Client shall use this value to prove possession of its ApplicationInstanceCertificate in the next call to ActivateSession request. |
results [] | StatusCode | List of validation results for the SoftwareCertificates (see 7.38 for StatusCode definition). |
diagnosticInfos [] | DiagnosticInfo | List of diagnostic information associated with SoftwareCertificate validation errors (see 7.12 for DiagnosticInfo definition). This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request. |