 | Cloud Fax and Notifications API 2.4 Documentation SOAP Header Elements | Cloud Fax and Notifications API Forums Home |
2.1 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 contains user authentication information 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] http://schemas.xmlsoap.org/soap/envelope/ | 0-1 | ||||||||||||||
| 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. | |||||||||||||
| ResponseRequired RequiredType | 0-1 | This optional element currently has no function, and should be omitted. | |||||||||||||
| ResultRequired RequiredType | 0-1 | This optional element currently has no function, and should be omitted. | |||||||||||||
| 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 | 1 | Identifies the user sending the request | |||||||||||||
| XDDSAuth XDDSAuthType | 1 | Contains the user authentication information. | |||||||||||||
| RequesterID xs:string | 1 | The user id of the user sending the request. Fax2Mail/Mail2Fax users who have registered their email address as an alias may also use their email address prefixed by "M2F " ("M","2","F",space) as the RequesterID. Note that jobs submitted using this form of the RequesterID will be marked in the system as mail2fax jobs. Users set up as Fax2Mail-only users must use this form. Other aliases recognized by the system may also be used, although only M2F (or INTERNET) have the side effect of marking the jobs as a specific type. The following alias type prefixes are supported:
| |||||||||||||
| TargetID xs:string | 0-1 | The user id (or the "M2F " email alias described under RequesterID) of the user on whose behalf the request is being sent. Currently, the only supported use of this field is to allow Fax2Mail "admin" users to perform certain actions on behalf of members of their administrative group. The following alias type prefixes are supported:
| |||||||||||||
| Password xs:string | 1 | Password associated with the RequesterID | |||||||||||||
| 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. | |||||||||||||
| © Copyright 2020 OpenText Corp. All Rights Reserved. Privacy Policy | Cookie Policy |
This information is subject to change. Please check frequently for updates. Modified October 06, 2020 |