WEBFaxGetTypes
| Initial Build | 2008.01 |
| xWeb | Web Method |
| Response Type | XML results |
This method can be used to get a list of fax types for use in a drop-down list to add or edit fax numbers.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBFaxGetTypes/>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
Shortened for brevity.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBFaxGetTypesResponse xmlns="http://www.avectra.com/2005/">
<WEBFaxGetTypesResult>
<Results recordReturn="3">
<Result>
<fxt_key>962e4552-adb0-4522-b309-2232083eaeb3</fxt_key>
<fxt_code>Home</fxt_code>
</Result>
<Result>
<fxt_key>b701c02a-d22e-486c-a943-39a93d65be85</fxt_key>
<fxt_code>Other</fxt_code>
</Result>
<Result>
<fxt_key>e5502ca6-2faf-4ebb-9fa4-236158bcbcb7</fxt_key>
<fxt_code>Work</fxt_code>
</Result>
</Results>
</WEBFaxGetTypesResult>
</WEBFaxGetTypesResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBFaxGetTypes
{
"WEBFaxGetTypes" : null
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "7",
"Result": [
{
"fxt_key": "aad2ad9a-961f-4a1f-b188-21dd063b5978",
"fxt_code": "Business"
},
{
"fxt_key": "a8b9dd5b-7d95-481b-935f-130b74793f6b",
"fxt_code": "fax5e67d0381fc83967"
},
{
"fxt_key": "9a37e167-0e1b-4fbe-b768-9d90ab2959d2",
"fxt_code": "fax7dd2bed41b5eb498"
},
{
"fxt_key": "d108a8c2-57d7-4306-8d66-c969dbc390a1",
"fxt_code": "fax9c450b565fe75394"
},
{
"fxt_key": "e82241ba-8c97-4af5-8d85-7a16d9bddba5",
"fxt_code": "Home"
},
{
"fxt_key": "f5c5b66f-2cc2-4c28-afb5-4c6a53f509a5",
"fxt_code": "Vacation-Fax"
},
{
"fxt_key": "7716e717-f748-4b39-8937-5d14892e36b6",
"fxt_code": "Work"
}
]
}
}