{"_id":"5b3a492c2be67a0003dd59db","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5b3a325acffe770003fd29e5","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-07-02T14:10:34.002Z","from_sync":false,"order":31,"slug":"preferences-1","title":"Preferences"},"user":"5a251846c297dc0012e531cd","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-02T15:47:56.097Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"This method returns an array of all preferences.\n\nIf no preferences exist, an empty array is returned, otherwise an array, containing an ordered tree structure of preferences and preference categories is returned.\n\n**SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetPreferences](doc:getpreferences)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Output parameters\",\n  \"body\": \"* GetPreferencesResult - *array of Preference objects*\\n    * Preference or Preference category\\n         * PreferenceID - *integer*\\n         * PublicName - *string*\\n         * PrivateName - *string*\\n         * IsPreference - *boolean*\\n         * Order - *integer*\\n         * IsPublic - *boolean*\\n         * CategoryID - *integer* or *string* ('top' or 'bottom')\\n         * PreferenceCount - *integer*\\n         * Created - *DateTime*\\n         * LastModified - *DateTime*\"\n}\n[/block]\n**Example**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"using (var client = new ApiServiceClient())\\n{\\n\\tclient.ClientCredentials.UserName.UserName = \\\"username\\\";\\n\\tclient.ClientCredentials.UserName.Password = \\\"password\\\";\\n\\n\\tvar preferences = client.GetPreferences();\\n}\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"Gets all the preferences and preference categories","slug":"getpreferences","type":"basic","title":"GetPreferences"}

GetPreferences

Gets all the preferences and preference categories

This method returns an array of all preferences. If no preferences exist, an empty array is returned, otherwise an array, containing an ordered tree structure of preferences and preference categories is returned. **SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetPreferences](doc:getpreferences) [block:callout] { "type": "info", "title": "Output parameters", "body": "* GetPreferencesResult - *array of Preference objects*\n * Preference or Preference category\n * PreferenceID - *integer*\n * PublicName - *string*\n * PrivateName - *string*\n * IsPreference - *boolean*\n * Order - *integer*\n * IsPublic - *boolean*\n * CategoryID - *integer* or *string* ('top' or 'bottom')\n * PreferenceCount - *integer*\n * Created - *DateTime*\n * LastModified - *DateTime*" } [/block] **Example** [block:code] { "codes": [ { "code": "using (var client = new ApiServiceClient())\n{\n\tclient.ClientCredentials.UserName.UserName = \"username\";\n\tclient.ClientCredentials.UserName.Password = \"password\";\n\n\tvar preferences = client.GetPreferences();\n}", "language": "csharp" } ] } [/block]