GetSubscriptionMailingTypes
| Initial Build | 2013.01 |
| xWeb | Web Method |
| Response Type | MailingList object |
The GetSubscriptionMailingTypes web method returns a list of subscription mailing types. These are mailing types that are defined lists, as opposed to promotional mailing types.
When working with Email Opt Outs and Managing Mail Preferences, these codes will tell you what the various mailing types are.
Parameters
This web method has no parameters.
Response
An array of MailingList objects.
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>*******</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:GetSubscriptionMailingTypes/>
</soapenv:Body>
</soapenv:Envelope>Sample Response
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. See NetForum Data for more information.
<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>c7137ef8-ea23-41cf-85e3-86b8673fb0ea</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<GetSubscriptionMailingTypesResponse xmlns="http://www.avectra.com/2005/">
<GetSubscriptionMailingTypesResult>
<MailingList>
<primary_key>fe7324d8-1016-454c-a2fb-16f5dd07453a</primary_key>
<name>test-8008</name>
<category>Participation</category>
</MailingList>
<MailingList>
<primary_key>865a6286-3f20-4d5e-a409-21c6d5295706</primary_key>
<name>this is my new registration #1</name>
<category>test</category>
</MailingList>
<MailingList>
<primary_key>679ee299-e6ef-4064-a1de-29e2fa218d81</primary_key>
<name>KLREG Mailing List</name>
<category>event</category>
</MailingList>
<MailingList>
<primary_key>e86b36bf-7ca2-4919-ad2e-3a7ef268ab39</primary_key>
<name>6334MailList</name>
<category>event</category>
</MailingList>
<MailingList>
<primary_key>ea7a5bd2-7a89-48de-87cf-3f5be4dff2e9</primary_key>
<name>11357 Mailing List</name>
<category>promotional</category>
</MailingList>
<MailingList>
<primary_key>c0ccc113-9239-4e5d-8e89-4892d3514d9c</primary_key>
<name>cm - ml - 01</name>
<category>cm - mlt - 01</category>
</MailingList>
<MailingList>
<primary_key>c052f2cd-3102-4967-b05a-4eccfb15a5fa</primary_key>
<name>11357 End Date</name>
<category>promotional</category>
</MailingList>
</GetSubscriptionMailingTypesResult>
</GetSubscriptionMailingTypesResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/GetSubscriptionMailingTypes
DATA: JSON
{
"GetSubscriptionMailingTypes" : null
}SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
[
{
"primary_key": "aaa01460-5a02-4440-b864-01af9eb16d40",
"name": "Do NOT Mail List",
"category": "Do NOT mail"
},
{
"primary_key": "85949132-dc97-46db-a80e-01c220e58df9",
"name": "Newsletter C",
"category": "Newsletters"
},
{
"primary_key": "73b16d05-a567-4afa-8189-09801e3b6999",
"name": "Grromtestt1",
"category": "Promotional"
},
{
"primary_key": "6e604254-7b98-4b0c-a9b3-0aaa9d3cb074",
"name": "CONSSS",
"category": "Announcements"
},
{
"primary_key": "be83a451-86ab-4d19-aa34-1200204c3c51",
"name": "HouseHold",
"category": "Announcements"
},
{
"primary_key": "87cd5463-eed8-4439-be8f-13f916c20e1e",
"name": "Promo I",
"category": "Promotional"
},
{
"primary_key": "22c1ea18-8455-4669-87d9-16cb617401a2",
"name": "dnm fi",
"category": "Do NOT mail"
},
{
"primary_key": "4c9d9fdc-9f58-45d4-9ad6-17621cf04b41",
"name": "MailingListTypeTestbjE4Ob",
"category": "MLTyTestbjE4Ob"
},
{
"primary_key": "4809fe0f-2e4d-44d7-aaeb-18b1dff01fa8",
"name": "Dhana Mailing List",
"category": "Promotional"
},
{
"primary_key": "90539eb7-64d9-4979-b6c5-1bd81fc568a3",
"name": "MayankML",
"category": "Announcements"
},
{
"primary_key": "ed0c8005-560d-4edd-abe6-1c98dc62d4c2",
"name": "135230_Maillling_list",
"category": "Announcements"
},
{
"primary_key": "07c7a322-b9a5-41a2-8a9e-223f82dd1c89",
"name": "MailingListTypeTestpyj3xg",
"category": "MLTyTestpyj3xg"
},
{
"primary_key": "cc74c9e1-e55b-47f3-b8c9-2826baa35a84",
"name": "111111111111111",
"category": "Promotional"
},
{
"primary_key": "d5e91309-e110-4cbe-a2e2-2a0c6e5d7057",
"name": "Test123",
"category": "Participation"
},
{
"primary_key": "2149c18e-43ba-458a-b6cf-2c127ad87097",
"name": "Promotional Mailing List",
"category": "Promotional"
},
{
"primary_key": "5a544ed7-11c5-4242-9076-2ff179215b36",
"name": "135230",
"category": "Announcements"
},
{
"primary_key": "75fef79c-f153-4747-90af-35cd80357c79",
"name": "666555444",
"category": "Announcements"
},
{
"primary_key": "88841aa5-9509-4a16-b451-37a9cdefa4f3",
"name": "promo nli",
"category": "Promotional"
},
{
"primary_key": "4b7de0bd-055d-48d7-af42-39c50412c5df",
"name": "MailingListTypeTestbVludH",
"category": "MLTyTestbVludH"
},
{
"primary_key": "0905b50e-9b2e-4753-be5f-3dcb56741341",
"name": "MailingListTypeTestoPSJoJ",
"category": "Participation"
},
{
"primary_key": "9ba665c2-b6c1-492d-a80d-3eecec9d1e30",
"name": "41414141",
"category": "Announcements"
},
{
"primary_key": "ceb2ef28-07c9-4435-9fd1-41ea8af1a860",
"name": "TestFF",
"category": "Announcements"
},
{
"primary_key": "568592c1-d91c-47ea-a5e4-4793d86f82ed",
"name": "cmt part",
"category": "Participation"
},
{
"primary_key": "b53bcd2c-75b6-4206-bda3-4811cb8e024a",
"name": "fsdfsdfsdfsdfsdfsdfsdfsdf",
"category": "Announcements"
},
{
"primary_key": "a12329d1-c1a2-40a9-b804-48bdefe83cbd",
"name": "Mailing List - Discussion List",
"category": "Discussion List"
},
{
"primary_key": "6bb2abad-bcae-4aa8-bb9f-4afe2849cdb8",
"name": "evt reg",
"category": "Participation"
},
{
"primary_key": "b2c8e994-0dac-4385-8ab1-4b1156a89cf1",
"name": "MailingListTypeTestpSlY2T",
"category": "MLTyTestpSlY2T"
},
{
"primary_key": "424bfc73-9aed-44b7-a055-5565d29da9d4",
"name": "aaadddd",
"category": "Discussion List"
},
{
"primary_key": "04dedb9c-5c04-42c9-b9f4-556e62427db9",
"name": "promo nqi",
"category": "Promotional"
},
{
"primary_key": "3f7e5a1c-0275-4d1e-bf7f-56997a26f957",
"name": "September Special",
"category": "Monthly Newsletter"
},
{
"primary_key": "23e4275d-0746-4d64-8047-57379c20637f",
"name": "Mailing List - Participation",
"category": "Participation"
},
{
"primary_key": "bad02d9b-3ea0-41a0-adc2-5838db1ef9dd",
"name": "ABC Mailing List 2021",
"category": "Newsletters"
},
{
"primary_key": "cb182ab0-cf2f-456f-9e68-5dfff1501ba4",
"name": "Grromtesttadsad",
"category": "Discussion List"
},
{
"primary_key": "e717937a-cbe1-4fa5-b2c0-5ead4836d749",
"name": "Newsletter I",
"category": "Newsletters"
},
{
"primary_key": "a1c77d49-a139-4f8b-a168-5eb0f8f3527d",
"name": "136106 Mailing LIst",
"category": "Participation"
},
{
"primary_key": "aa3d69c0-7c2f-40bb-b3fe-6a88776076b7",
"name": "Shashi_Test",
"category": "Discussion List"
},
{
"primary_key": "f24da7e7-312f-42f2-b81c-6c85cbc98ecf",
"name": "7777",
"category": "MLTyTestbVludH"
},
{
"primary_key": "fe83a043-3e86-4a73-bf3d-6d42a19e564f",
"name": "MailingListTypeTestcgY029",
"category": "MLTyTestcgY029"
},
{
"primary_key": "ead8065d-fcea-4b5c-bc6b-6ebe360c907d",
"name": "22222",
"category": "Announcements"
},
{
"primary_key": "afc5d87a-2dc2-4df0-8783-6fcfd1a81c52",
"name": "ann ci",
"category": "Announcements"
},
{
"primary_key": "bf9f7445-8a6b-4304-a2ab-707a698cbbf3",
"name": "xczxzx",
"category": "Announcements"
},
{
"primary_key": "26dc3785-94c4-433a-94e3-752bbb7540b6",
"name": "news cfi",
"category": "Newsletters"
},
{
"primary_key": "5af52ca1-df31-4392-8707-75db71ad4eeb",
"name": "fsdf",
"category": "Discussion List"
},
{
"primary_key": "7ca75374-ffbc-4159-a696-7b9cb60254f6",
"name": "136106-1",
"category": "Promotional"
},
{
"primary_key": "85f35be3-ccbc-4aaa-bb88-7e64b6be977d",
"name": "AkshayMailingList",
"category": "Promotional"
},
{
"primary_key": "53ed52f1-795f-4447-8330-7f87482b836f",
"name": "AkshayMailingListfds",
"category": "Participation"
},
{
"primary_key": "d9e815a1-0831-4fe8-8628-810972906186",
"name": "jls_ml test2",
"category": "Promotional"
},
{
"primary_key": "313285ef-921a-4535-8595-823d3b0d9436",
"name": "erwerew",
"category": "Announcements"
},
{
"primary_key": "40700e23-da03-4483-9872-8369fedda4ff",
"name": "Grromtesttrtrty",
"category": "Announcements"
},
{
"primary_key": "0b9a588d-d9f6-4816-9fe4-8869bce23a9c",
"name": "Pravin_Mailing_List",
"category": "Promotional"
},
{
"primary_key": "37a68eaa-6d41-43ff-847f-9017358a8c0c",
"name": "Promo C",
"category": "Promotional"
},
{
"primary_key": "bf82681b-70c8-4a52-a9d9-9603b51e97aa",
"name": "jls_ml test",
"category": "Test 1"
},
{
"primary_key": "799f5cb2-7b2c-4dbb-99be-9a5d71e6b903",
"name": "Test4",
"category": "Announcements"
},
{
"primary_key": "4684c534-9732-4217-9373-a0a31a7a7dff",
"name": "MailingListTypeTestCLbgJ7",
"category": "MLTyTestCLbgJ7"
},
{
"primary_key": "1ef5a5c1-4dad-42fc-8529-a191c4885371",
"name": "Test_2",
"category": "Announcements"
},
{
"primary_key": "153e8d8b-fa84-4d96-b230-a52b0f6c3433",
"name": "MailingListTypeTestaM71LM",
"category": "MLTyTestaM71LM"
},
{
"primary_key": "99c94821-340a-435a-bf42-a5f2997ec7f8",
"name": "MailingListTypeTestUY9TG0",
"category": "Participation"
},
{
"primary_key": "b1a6a740-c71d-4178-a54f-a6a8454c4a72",
"name": "COI-req 1",
"category": "COI"
},
{
"primary_key": "fdf73b8e-d0c3-4c02-93fe-a8fd42d5f97d",
"name": "Pravin Test123",
"category": "Pravin"
},
{
"primary_key": "5c686132-41ed-4e80-91a4-ac97990b5ad9",
"name": "Mailing List - Announcements",
"category": "Announcements"
},
{
"primary_key": "85545548-c141-4ecc-a61d-b3f107ae3c78",
"name": "part cci",
"category": "Participation"
},
{
"primary_key": "59c7830e-06a5-4a0f-b105-b4015fa8d483",
"name": "Tracy Fussell",
"category": "Announcements"
},
{
"primary_key": "6f34d0e1-c5b5-4722-b2a2-b423956bdd06",
"name": "Mailing List - Newsletters",
"category": "Newsletters"
},
{
"primary_key": "a9031180-3d09-4202-bced-c2eda153a73b",
"name": "FixLocal",
"category": "Announcements"
},
{
"primary_key": "b2fd6c6c-bf34-4c75-b5e7-c6b4115e1eac",
"name": "Test IE",
"category": "Announcements"
},
{
"primary_key": "c847db46-d116-4504-9f70-c927b1d4cda2",
"name": "Test_123",
"category": "Discussion List"
},
{
"primary_key": "631df769-25f6-4ccf-943c-ca3c0424a233",
"name": "Newsletter F",
"category": "Newsletters"
},
{
"primary_key": "d7462b33-02d4-4e23-8284-cab14c233a81",
"name": "Promo F",
"category": "Promotional"
},
{
"primary_key": "0b2d3084-0eb1-4e7b-bf53-cb4fcbe2dacf",
"name": "zzzzz",
"category": "Discussion List"
},
{
"primary_key": "13a99dbd-a3d0-4b63-9104-cb6d9523959d",
"name": "sadsad",
"category": "Announcements"
},
{
"primary_key": "fecd7d27-a83d-4138-984a-cd6e455f8fcb",
"name": "Promo A",
"category": "Promotional"
},
{
"primary_key": "708f670f-97bb-47d9-99c9-cdb085f57e15",
"name": "5234",
"category": "Announcements"
},
{
"primary_key": "03d6d404-329f-482d-8cd7-d39db5241185",
"name": "Promo B",
"category": "Promotional"
},
{
"primary_key": "130413fd-35da-4d1d-a534-d3f4847524ff",
"name": "123321123",
"category": "Announcements"
},
{
"primary_key": "dd64908a-8fbd-4ed9-9261-d444297ebeae",
"name": "Promo E",
"category": "Promotional"
},
{
"primary_key": "e659d8fc-d9dd-46dd-9fa1-d550ba62a3a5",
"name": "Test3",
"category": "Announcements"
},
{
"primary_key": "ddf279cd-6628-4ed7-adc4-d7144e37d7db",
"name": "MailingListTypeTestfo5Hvd",
"category": "MLTyTestfo5Hvd"
},
{
"primary_key": "6655ed6a-7274-4939-89b9-d8bbb4f83a89",
"name": "Test2",
"category": "Announcements"
},
{
"primary_key": "c3ef1fbf-b45e-43b5-ac0e-dffb5743134b",
"name": "gggggg",
"category": "Announcements"
},
{
"primary_key": "746e06d4-b34d-4d2e-8ef4-e083658dce21",
"name": "Newsletter E",
"category": "Newsletters"
},
{
"primary_key": "adc7a4b6-829f-4aa3-9e27-eaa2e9eb8080",
"name": "grgrgrgrtgr",
"category": "Announcements"
},
{
"primary_key": "73bc8974-f8f6-4ac1-b1ef-eb6898857cb3",
"name": "part c",
"category": "Participation"
},
{
"primary_key": "6f860a68-784a-4330-89a4-ee40c49f3bbc",
"name": "Test Chrome",
"category": "Announcements"
},
{
"primary_key": "ed69022c-b9ba-419d-a225-f2fa54d641d6",
"name": "Mailing List - Auctions",
"category": "Newsletters"
},
{
"primary_key": "998bd49d-86ce-494b-9647-f3810b4fa935",
"name": "MailingListTypeTestHHhdBw",
"category": "MLTyTestHHhdBw"
},
{
"primary_key": "9dd636a2-5d39-4bbf-967c-f505ecdbb2b6",
"name": "ABC_TFS130335_MailingList",
"category": "Participation"
}
]
Related Web Methods
- GetPromotionalMailingTypes - Get available promotional mailing types available.
- GetCustomerCommunicationPreference - Retrieve an individual's communication preference for a single mailing type.
- GetAllCustomerCommunicationPreferences - Retrieve all of an individual's communication preferences.
- SetCustomerCommunicationPreferences - Set an individual's communication preferences.
Recommendations
Information about mailing types 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.