 | Cloud Fax and Notifications API 2.5 Documentation User Credentials and SOAP Header Elements | Cloud Fax and Notifications API Forums Home |
2.2 Request
The Request element is used in the Header of every SOAP message sent from the user to the Cloud Fax and Notifications API. It may contain information about the requesting and effective user, and (for asynchronous usage) the URL to receive the results.
There are several different namespaces containing the Request element - consult the WSDL to determine the appropriate schema to use for any particular request. For current function versions, the appropriate namespace is also shown in these pages in each function's Overview page.
| Tag Name & type | # | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Request | ||||||||||||||||
| @[any] ##any | 0-1 | Arbitrary attributes are allowed. This permits adding WS-Security Id if desired. | ||||||||||||||
| SenderKey xs:anyURI | 0-1 | URI associated with the sender of the message. If sent in an async request, this must be the URL of the webservice to which the result will be sent. | ||||||||||||||
| ReceiverKey xs:anyURI | 1 | URI associated with the receiver. Generally this should be the URL to which the request was sent. | ||||||||||||||
| RequestID xs:string | 0-1 | A string that may be included to identify a specific request. If provided, it will be echoed in the Response element of the reply. | ||||||||||||||
| Authentication | 0-1 | Contains information about the user making the request. If user credentials are being provided by including the userid and password, this element is necessary. If user credentials are being provided via an X.509 certificate and XML signature, then this element is only necessary if a RequesterType is necessary, or if a different user is specified as a TargetID. | ||||||||||||||
| XDDSAuth XDDSAuthType | 1 | When user credentials are being provided by supplying a userid and password, this element must be used. | ||||||||||||||
| RequesterID UIDType | 1 | The user id of the user sending the request. A user "alias" can be used instead of the ordinary user id, if the alias type is indicated using the aliasType attribute. This is most commonly done for Fax2Mail/Mail2Fax users who have registered their email address as an alias - the email address is the value of this element, and the aliasType attribute is set to "M2F". (Fax2Mail-only users must use this form.) | ||||||||||||||
| @aliasType xs:string | 0-1 | If a user alias is used as the RequesterID, the type of alias must be specified using this attribute. If this attribute is not present, the ID will be assumed to be an ordinary user id. The most common alias type in use is M2F (or INTERNET), and using this alias type in a JobSubmit request has the side effect of marking the job as a mail2fax job. (Fax2Mail-only users must therefore use this form.) Other aliases recognized by the system may also be used, although only M2F (or INTERNET) has the side effect of marking submitted jobs as a specific type. The following alias types are supported:
| ||||||||||||||
| TargetID UIDType | 0-1 | This identifies the user on whose behalf the request is being sent. Currently, the ability to submit requests on behalf of other users may only be used by Fax2Mail "admin" users to perform certain actions on behalf of members of their administrative group. This element may contain a user id, or (if aliasType is used) a user alias, such as a registered email address. | ||||||||||||||
| @aliasType xs:string | 0-1 | If a user alias is used as the TargetID, the type of alias must be specified using this attribute. If this attribute is not present, the ID will be assumed to be an ordinary user id. The most common alias type in use is M2F (or INTERNET), and using this alias type in a JobSubmit request has the side effect of marking the job as a mail2fax job. (Fax2Mail-only users must therefore use this form.) The job type indicated by a TargetID alias overrides any such indication in the RequesterID. Other aliases recognized by the system may also be used, although only M2F (or INTERNET) has the side effect of marking submitted jobs as a specific type. The following alias types are supported:
| ||||||||||||||
| Password xs:string | 1 | Password associated with the RequesterID | ||||||||||||||
| WSSAuth WSSAuthType | 1 | When user credentials are being provided via an X.509 certificate and XML signature, then this element should be used if it is necessary to specify a RequesterType or TargetID. If this additional information is not needed, then neither WSSAuth or the Authentication elements are necessary, although a Request element must still be present in the SOAP Header. | ||||||||||||||
| RequesterType xs:string | 0-1 | An X.509 certificate identifies the requesting user, but correct processing may depend on the type of user indicated in the request. This is mainly true for JobSubmit, where a RequesterType of M2F (or INTERNET) will cause the job to be marked as a mail2fax job. Specifying a RequesterType is functionally equivalent to specifying an aliasType for RequesterID. The following RequesterType values (alias types) are supported:
| ||||||||||||||
| TargetID UIDType | 0-1 | This identifies the user on whose behalf the request is being sent. Currently, the ability to submit requests on behalf of other users may only be used by Fax2Mail "admin" users to perform certain actions on behalf of members of their administrative group. This element may contain a user id, or (if aliasType is used) a user alias, such as a registered email address. | ||||||||||||||
| @aliasType xs:string | 0-1 | If a user alias is used as the TargetID, the type of alias must be specified using this attribute. If this attribute is not present, the ID will be assumed to be an ordinary user id. The most common alias type in use is M2F (or INTERNET), and using this alias type in a JobSubmit request has the side effect of marking the job as a mail2fax job. (Fax2Mail-only users must therefore use this form.) The job type indicated by a TargetID alias overrides any such indication in the RequesterType. Other aliases recognized by the system may also be used, although only M2F (or INTERNET) has the side effect of marking submitted jobs as a specific type. The following alias types are supported:
| ||||||||||||||
| InputChannel xs:string | 0-1 | Switch activity may be influenced by an input channel value assigned to a user. If one has been assigned, the assigned value should be supplied in this element. | ||||||||||||||
| ResultOption | 0- | This element may be used to specify additional options for processing the request or returning the result. No such options are currently defined. | ||||||||||||||
| @name xs:string | 0-1 | If options are defined that require a name as well as a value, this attribute will be used for the name. No such options are currently defined. | ||||||||||||||
| © Copyright 2020 OpenText Corp. All Rights Reserved. Privacy Policy | Cookie Policy |
This information is subject to change. Please check frequently for updates. Modified September 18, 2012 |