{"_id":"560eb13e54af2b0d005bbf7a","project":"55dd9f2e0efd5821000d54d9","user":"55dd9841cafe7221002a4c62","__v":20,"parentDoc":null,"category":{"_id":"560eb0f659cb8d0d0015cd52","pages":["560eb13e54af2b0d005bbf7a"],"__v":1,"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-02T16:29:42.121Z","from_sync":false,"order":18,"slug":"soap","title":"SOAP"},"version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":["563089e6242cda1900198a72","56323268fe9acd1900cc1cea"],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T16:30:54.294Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Our SOAP API documentation largely assumes you have already downloaded our WSDL description. If you haven't already done this, we strongly recommend it. The WSDL is available here:\n\nhttps://api.dotmailer.com/v2/api.svc\n\nPlease see the steps below on how to add this to Visual Studio.\n\nFind out more about [SOAP](https://en.wikipedia.org/wiki/SOAP) and [WSDL](https://en.wikipedia.org/wiki/Web_Services_Description_Language).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Should I be using SOAP or REST?\",\n  \"body\": \"Users of Java and .NET often prefer SOAP, while users of dynamic languages like PHP or Ruby tend to prefer REST. But it's up to you!\"\n}\n[/block]\n## Adding our SOAP service reference to Visual Studio \n\n**Step 1** - Right click your project and select **Add** > **Service Reference…**\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/63HXAKk3QDexA8R2MNa5_SOAP_step_1.png\",\n        \"SOAP_step_1.png\",\n        \"586\",\n        \"609\",\n        \"#3ea0f2\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Step 2** - A dialog will appear. Enter the address https://api.dotmailer.com/v2/api.svc and then click **Go**. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Make sure to enter https here and *not* http.\",\n  \"title\": \"Important\"\n}\n[/block]\nThe service reference will appear in the *Services* window where you can explore the different methods.\n\nYou can then add the namespace of your choosing. In our example we’ve used *dotmailerApi*.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0xqaUqzVQSAkZaQjqS3E_SOAP_step_2.png\",\n        \"SOAP_step_2.png\",\n        \"634\",\n        \"515\",\n        \"#a64d3f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Step 3** - Reference the namespace in your code in a *using* statement and away you go.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/RjWrsxqTM6UyHaSXsONo_SOAP_step_3.png\",\n        \"SOAP_step_3.png\",\n        \"235\",\n        \"106\",\n        \"#4d9fbc\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"about-our-soap-api","type":"basic","title":"About our SOAP API"}

About our SOAP API


Our SOAP API documentation largely assumes you have already downloaded our WSDL description. If you haven't already done this, we strongly recommend it. The WSDL is available here: https://api.dotmailer.com/v2/api.svc Please see the steps below on how to add this to Visual Studio. Find out more about [SOAP](https://en.wikipedia.org/wiki/SOAP) and [WSDL](https://en.wikipedia.org/wiki/Web_Services_Description_Language). [block:callout] { "type": "info", "title": "Should I be using SOAP or REST?", "body": "Users of Java and .NET often prefer SOAP, while users of dynamic languages like PHP or Ruby tend to prefer REST. But it's up to you!" } [/block] ## Adding our SOAP service reference to Visual Studio **Step 1** - Right click your project and select **Add** > **Service Reference…** [block:image] { "images": [ { "image": [ "https://files.readme.io/63HXAKk3QDexA8R2MNa5_SOAP_step_1.png", "SOAP_step_1.png", "586", "609", "#3ea0f2", "" ] } ] } [/block] **Step 2** - A dialog will appear. Enter the address https://api.dotmailer.com/v2/api.svc and then click **Go**. [block:callout] { "type": "warning", "body": "Make sure to enter https here and *not* http.", "title": "Important" } [/block] The service reference will appear in the *Services* window where you can explore the different methods. You can then add the namespace of your choosing. In our example we’ve used *dotmailerApi*. [block:image] { "images": [ { "image": [ "https://files.readme.io/0xqaUqzVQSAkZaQjqS3E_SOAP_step_2.png", "SOAP_step_2.png", "634", "515", "#a64d3f", "" ] } ] } [/block] **Step 3** - Reference the namespace in your code in a *using* statement and away you go. [block:image] { "images": [ { "image": [ "https://files.readme.io/RjWrsxqTM6UyHaSXsONo_SOAP_step_3.png", "SOAP_step_3.png", "235", "106", "#4d9fbc", "" ] } ] } [/block]