WEBContactRequestGetOriginations

Initial Build	2008.01
xWeb	Web Method
Response Type	XML results

The WEBContactRequestGetOriginations web method returns a list of request origins that are needed to create a Request in the WEBContactRequestInsert web method.

Origins define where the request originated such as from the website, phone, e-mail, and so on.

In most cases, any requests generated by a particular application will always have the same origin. Therefore, in your application you might want to configure a constant value for this setting and always pass that value to WEBContactRequestInsert, rather than calling this web method repeatedly within your application.

Parameters

None

Response

XML Results.

Name	Description	Datatype	Notes
cro_key	Origin Key	string (in guid format)	ColumnDescriptionGoesHere
cro_code	Origin Code	string	ColumnDescriptionGoesHere

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>6e9b1f2e-a3ab-4a8f-8590-534c9ff54406</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBContactRequestGetOriginations/>
</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>6e9b1f2e-a3ab-4a8f-8590-534c9ff54406</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBContactRequestGetOriginationsResponse xmlns="http://www.avectra.com/2005/">
<WEBContactRequestGetOriginationsResult>
<Results recordReturn="3">
<Result>
<cro_key>a0fa1b36-348b-4f95-9dce-a99198e63fcf</cro_key>
<cro_code>Web</cro_code>
</Result>
<Result>
<cro_key>a401ae75-53d5-4e29-94d2-432ab96598f0</cro_key>
<cro_code>Phone</cro_code>
</Result>
<Result>
<cro_key>z401ae75-53d5-4e29-94d2-432ab96598f0</cro_key>
<cro_code>Mail</cro_code>
</Result>
</Results>
</WEBContactRequestGetOriginationsResult>
</WEBContactRequestGetOriginationsResponse>
</soap:Body>
</soap:Envelope>

Important! The sample for this method contains sample data. Do not assume that the specific data you see on this page, particularly the keys, are the same data that will exist in the netFORUM site in which you're developing an integration. Moreover, if you are developing an integration that will work against multiple netFORUM sites for multiple customers, be aware that the data for each customer, including setup data, will differ.

JSON Method

POST /xWeb/JSON/WEBContactRequestGetOriginations

DATA: JSON
{
    "WEBContactRequestGetOriginations": null
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "6",
        "Result": [
            {
                "cro_key": "a3e1e5eb-573f-4245-ba17-b763f91d7847",
                "cro_code": "E-Marketing"
            },
            {
                "cro_key": "e92cd5dd-db57-47ab-80be-e53954406650",
                "cro_code": "Fax"
            },
            {
                "cro_key": "d77eeede-6b13-49a1-a271-3ec6d24c6255",
                "cro_code": "Phone"
            },
            {
                "cro_key": "6c74d64f-ee46-4f8a-8aff-4b86fdab9d87",
                "cro_code": "ro2EmailkIX15z"
            },
            {
                "cro_key": "fef09373-cfa9-404e-bb23-813985195e34",
                "cro_code": "ro2EmailzRpKip"
            },
            {
                "cro_key": "5e8d31fa-f51f-4129-bbd9-0ff1452c9d17",
                "cro_code": "Web"
            }
        ]
    }
}

Related Web Methods

WEBContactRequestInsert

Related Functionality

request origins

Recommendations

Information about request origins rarely changes. Therefore we recommend you cache these results and get a new list on a regular interval, especially in a high-traffic application that calls this method frequently.