WEBAddressGetTypes

This method can be used to populate a drop-down list of Address Types when inserting or updating customer addresses. You'll take the value of adt_key and use it to set the value of the cxa_adt_key in the WEBAddressInsert or WEBAddressUpdate or other Insert web methods.

Parameters

This method accepts no parameters.

Response

This method returns the key and code for each address type.

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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBAddressGetTypes/>
</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>
<WEBAddressGetTypesResponse xmlns="http://www.avectra.com/2005/">
<WEBAddressGetTypesResult>
<Results recordReturn="5">
<Result>
<adt_key>927e7193-0184-4179-aeb7-0736d7ba6e0b</adt_key>
<adt_code>Billing</adt_code>
</Result>
<Result>
<adt_key>bd0d2e2c-c501-4239-8307-148314cbb236</adt_key>
<adt_code>Home</adt_code>
</Result>
<Result>
<adt_key>95fd4cc2-1021-40d2-b01d-40e955964ecf</adt_key>
<adt_code>Other</adt_code>
</Result>
<Result>
<adt_key>d21ebd2d-a314-415d-8bb6-94ce679ce82f</adt_key>
<adt_code>Shipping</adt_code>
</Result>
<Result>
<adt_key>48044466-bf02-47c5-bb7a-9a1282194659</adt_key>
<adt_code>Work</adt_code>
</Result>
</Results>
</WEBAddressGetTypesResult>
</WEBAddressGetTypesResponse>
</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/WEBAddressGetTypes

DATA: JSON
{
    "WEBAddressGetTypes": null
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "7",
        "Result": [
            {
                "adt_key": "bf9dff92-c4ad-4ea8-b21a-ada3badf0002",
                "adt_code": "Billing"
            },
            {
                "adt_key": "8ec4a9f4-30a2-40b3-bc47-8aaeffd0786d",
                "adt_code": "Business"
            },
            {
                "adt_key": "fa137b33-4e39-4093-9e60-ebf5437d60aa",
                "adt_code": "Holiday"
            },
            {
                "adt_key": "62378dc8-0e9d-46d7-9500-8f74d9058ff3",
                "adt_code": "Home"
            },
            {
                "adt_key": "b48ce979-3ca4-4062-acfa-f72bb084462a",
                "adt_code": "Other"
            },
            {
                "adt_key": "b12a31b5-dbc8-4895-9268-fbbbfa6f584c",
                "adt_code": "Shipping"
            },
            {
                "adt_key": "50f15122-6041-483f-8442-b297ebd8d408",
                "adt_code": "Work"
            }
        ]
    }
}