{"__v":17,"_id":"56ab9094678b58170031ebd4","category":{"__v":3,"_id":"568fd23804440a1700e4cb5b","pages":["569fb6a8b4f2d31900898ced","56ab2dc70b9e0b0d006161c4","56efbfcb20419a0e00113caa"],"project":"568fce2a04440a1700e4cb47","version":"568fce2b04440a1700e4cb4a","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-08T15:14:00.072Z","from_sync":false,"order":7,"slug":"soap-web-services","title":"SOAP API"},"parentDoc":null,"project":"568fce2a04440a1700e4cb47","user":"55116f88e2990b0d00fb0552","version":{"__v":20,"_id":"568fce2b04440a1700e4cb4a","project":"568fce2a04440a1700e4cb47","createdAt":"2016-01-08T14:56:43.101Z","releaseDate":"2016-01-08T14:56:43.101Z","categories":["568fce2b04440a1700e4cb4b","568fd1b8b700ce0d002f4b1c","568fd23804440a1700e4cb5b","568fd2444719c119002ce5d8","568ff21204440a1700e4cbc1","5693732c8aa8040d009f2c28","5693738393445b0d00abdad0","5693740093445b0d00abdad1","56937445974aaa0d001ca699","5693b82173f48f0d0075c90d","5694c4cd1005590d0062cb25","569f854466a5640d00efa54c","56a264cdd15dd70d008d825b","56aa56bf318e6c1700a19ddb","56b0e6347ae4550d000627bd","56b200c0f48f270d00e0de6f","56b200c6f48f270d00e0de70","56b22a9665ddf50d0076ba40","56e92ef71996862200fd7f42","574d6577fb835c0e00ca316a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-29T16:17:24.432Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This method is restricted to authorised users only as of preferred method of sending data to customer is the [forwarding system](doc:url-click-forwarding), rather than polling for efficiency reasons. If you are interested in using this method please contact us to arrange access.\",\n  \"title\": \"Restricted Access\"\n}\n[/block]\nIf you are using the Dynmark Intelligent Tracking system, where we keep a record of any URLs you may have sent and capture the click details, you will be able to poll for the click details we have received for you by calling PollClickDetails. Each call to this method will return a batch of click details and a unique identifier for the start of the batch that can be used for replay in the event of an error within your own system.\n\n##Request\n\n**For Soap 1.0 & 1.1 the service endpoint is**\n<div class=\"alert alert-success\"><div class=\"label label-success\">SOAP</div> **https://services.dynmark.com/Soap/Basic/1.1/TrackingService**\n\n<div class=\"label label-success\">WSDL</div>  **https://services.dynmark.com/Soap/Basic/1.1/TrackingService?wsdl**</div>\n    \n**For Soap 1.2 the service endpoint is**\n<div class=\"alert alert-success\"><div class=\"label label-success\">SOAP</div> **https://services.dynmark.com/Soap/Basic/1.2/TrackingService**\n\n<div class=\"label label-success\">WSDL</div> **https://services.dynmark.com/Soap/Basic/1.2/TrackingService?wsdl**</div>\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<code>BatchSize</code><span class=\\\"c-danger\\\">*</span>\",\n    \"2-0\": \"<code>ImpersonateUsername</code>\",\n    \"1-0\": \"<code>ResetKey</code>\",\n    \"0-1\": \"The maximum number of click details to return. This must be in the range 50 - 10000, you should supply a batch size tuned to your system\",\n    \"2-1\": \"If you are a reseller, then passing the username of a child account’s user will fetch inbound messages for that user\",\n    \"1-1\": \"The optional batch key that can be used to rewind the system a specific batch in the event of a client error\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n##Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"<code>ClickDetails</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-0\": \"<code>ResetKey</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-1\": \"A batch key that can be used to replay from the start of this batch in the event of a client error\",\n    \"0-1\": \"An array of [PollClickDetails](#section-messagereceipt-object) objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##PollClickDetails Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"Where available, the browser used in the click request\",\n    \"1-1\": \"The date and time the click was received (UTC)\",\n    \"3-1\": \"The identifier for the original message group as set by the client. For example, if you send tracked URLs in an SMS campaign from our Campaign Manager application, it will be set to the campaign name.\",\n    \"4-1\": \"Where available the manufacturer of the device used during the click event\",\n    \"6-1\": \"The URL the client was directed to on the click event\",\n    \"6-0\": \"<code>ForwardUrl</code><span class=\\\"c-danger\\\">*</span>\",\n    \"4-0\": \"<code>DeviceManufacturer</code><span class=\\\"c-danger\\\">*</span>\",\n    \"3-0\": \"<code>ClientIdentifier</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-0\": \"<code>ClickDate</code><span class=\\\"c-danger\\\">*</span>\",\n    \"0-0\": \"<code>Browser</code><span class=\\\"c-danger\\\">*</span>\",\n    \"2-0\": \"<code>ClickDetailId</code><span class=\\\"c-danger\\\">*</span>\",\n    \"2-1\": \"A unique integer identifier for this click – allowing you to handle duplicates\",\n    \"5-0\": \"<code>DeviceName</code><span class=\\\"c-danger\\\">*</span>\",\n    \"5-1\": \"Where available the name of the device used during the click event\",\n    \"7-0\": \"<code>IsWarningPageServed</code><span class=\\\"c-danger\\\">*</span>\",\n    \"8-0\": \"<code>MessageId</code><span class=\\\"c-danger\\\">*</span>\",\n    \"9-0\": \"<code>PhoneNumber</code><span class=\\\"c-danger\\\">*</span>\",\n    \"10-0\": \"<code>Referrer</code><span class=\\\"c-danger\\\">*</span>\",\n    \"11-0\": \"<code>ShortenDate</code><span class=\\\"c-danger\\\">*</span>\",\n    \"12-0\": \"<code>TimeToClick</code><span class=\\\"c-danger\\\">*</span>\",\n    \"13-0\": \"<code>TrackingUrlId</code><span class=\\\"c-danger\\\">*</span>\",\n    \"14-0\": \"<code>UserAgent</code><span class=\\\"c-danger\\\">*</span>\",\n    \"15-0\": \"<code>UserId</code><span class=\\\"c-danger\\\">*</span>\",\n    \"16-0\": \"<code>Username</code><span class=\\\"c-danger\\\">*</span>\",\n    \"17-0\": \"<code>ClientReference</code><span class=\\\"c-danger\\\">*</span>\",\n    \"17-1\": \"The client ref value is a value that can be populated by the user when a message is sent through the Dynmark Web Services. The value that was specified in the related message will be returned with the click detail\",\n    \"16-1\": \"The owner user name of the tracked URL\",\n    \"15-1\": \"The owner user Id of the tracked URL\",\n    \"14-1\": \"Where available the UserAgent string from the click event (used to determine the browser above)\",\n    \"13-1\": \"A unique integer identifier for this Tracked URL – allowing you to track multiple clicks\",\n    \"12-1\": \"The time set as a Timespan of the difference between shortening and clicking\",\n    \"11-1\": \"The date and time the original URL was set for tracking\",\n    \"10-1\": \"Where available the referring URL of the tracked URL, for example if the URL has been placed on a web page\",\n    \"9-1\": \"PhoneNumber\\tThe phone number the tracked URL was originally sent to\",\n    \"8-1\": \"Where available the message Id for the original outbound message that contained the tracked URL\",\n    \"7-1\": \"An indicator to show that prior to forwarding we have displayed our warning page, this will happen if the URL being forwarded to is listed as being a possible malware or phishing site, if this is set to true you should contact support\"\n  },\n  \"cols\": 2,\n  \"rows\": 18\n}\n[/block]","excerpt":"","slug":"soap-polling-pollclickdetails","type":"fn","title":"PollClickDetails"}
[block:callout] { "type": "warning", "body": "This method is restricted to authorised users only as of preferred method of sending data to customer is the [forwarding system](doc:url-click-forwarding), rather than polling for efficiency reasons. If you are interested in using this method please contact us to arrange access.", "title": "Restricted Access" } [/block] If you are using the Dynmark Intelligent Tracking system, where we keep a record of any URLs you may have sent and capture the click details, you will be able to poll for the click details we have received for you by calling PollClickDetails. Each call to this method will return a batch of click details and a unique identifier for the start of the batch that can be used for replay in the event of an error within your own system. ##Request **For Soap 1.0 & 1.1 the service endpoint is** <div class="alert alert-success"><div class="label label-success">SOAP</div> **https://services.dynmark.com/Soap/Basic/1.1/TrackingService** <div class="label label-success">WSDL</div> **https://services.dynmark.com/Soap/Basic/1.1/TrackingService?wsdl**</div> **For Soap 1.2 the service endpoint is** <div class="alert alert-success"><div class="label label-success">SOAP</div> **https://services.dynmark.com/Soap/Basic/1.2/TrackingService** <div class="label label-success">WSDL</div> **https://services.dynmark.com/Soap/Basic/1.2/TrackingService?wsdl**</div> [block:parameters] { "data": { "0-0": "<code>BatchSize</code><span class=\"c-danger\">*</span>", "2-0": "<code>ImpersonateUsername</code>", "1-0": "<code>ResetKey</code>", "0-1": "The maximum number of click details to return. This must be in the range 50 - 10000, you should supply a batch size tuned to your system", "2-1": "If you are a reseller, then passing the username of a child account’s user will fetch inbound messages for that user", "1-1": "The optional batch key that can be used to rewind the system a specific batch in the event of a client error", "h-0": "Parameter", "h-1": "Description" }, "cols": 2, "rows": 3 } [/block] ##Response [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "<code>ClickDetails</code><span class=\"c-danger\">*</span>", "1-0": "<code>ResetKey</code><span class=\"c-danger\">*</span>", "1-1": "A batch key that can be used to replay from the start of this batch in the event of a client error", "0-1": "An array of [PollClickDetails](#section-messagereceipt-object) objects" }, "cols": 2, "rows": 2 } [/block] ##PollClickDetails Object [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-1": "Where available, the browser used in the click request", "1-1": "The date and time the click was received (UTC)", "3-1": "The identifier for the original message group as set by the client. For example, if you send tracked URLs in an SMS campaign from our Campaign Manager application, it will be set to the campaign name.", "4-1": "Where available the manufacturer of the device used during the click event", "6-1": "The URL the client was directed to on the click event", "6-0": "<code>ForwardUrl</code><span class=\"c-danger\">*</span>", "4-0": "<code>DeviceManufacturer</code><span class=\"c-danger\">*</span>", "3-0": "<code>ClientIdentifier</code><span class=\"c-danger\">*</span>", "1-0": "<code>ClickDate</code><span class=\"c-danger\">*</span>", "0-0": "<code>Browser</code><span class=\"c-danger\">*</span>", "2-0": "<code>ClickDetailId</code><span class=\"c-danger\">*</span>", "2-1": "A unique integer identifier for this click – allowing you to handle duplicates", "5-0": "<code>DeviceName</code><span class=\"c-danger\">*</span>", "5-1": "Where available the name of the device used during the click event", "7-0": "<code>IsWarningPageServed</code><span class=\"c-danger\">*</span>", "8-0": "<code>MessageId</code><span class=\"c-danger\">*</span>", "9-0": "<code>PhoneNumber</code><span class=\"c-danger\">*</span>", "10-0": "<code>Referrer</code><span class=\"c-danger\">*</span>", "11-0": "<code>ShortenDate</code><span class=\"c-danger\">*</span>", "12-0": "<code>TimeToClick</code><span class=\"c-danger\">*</span>", "13-0": "<code>TrackingUrlId</code><span class=\"c-danger\">*</span>", "14-0": "<code>UserAgent</code><span class=\"c-danger\">*</span>", "15-0": "<code>UserId</code><span class=\"c-danger\">*</span>", "16-0": "<code>Username</code><span class=\"c-danger\">*</span>", "17-0": "<code>ClientReference</code><span class=\"c-danger\">*</span>", "17-1": "The client ref value is a value that can be populated by the user when a message is sent through the Dynmark Web Services. The value that was specified in the related message will be returned with the click detail", "16-1": "The owner user name of the tracked URL", "15-1": "The owner user Id of the tracked URL", "14-1": "Where available the UserAgent string from the click event (used to determine the browser above)", "13-1": "A unique integer identifier for this Tracked URL – allowing you to track multiple clicks", "12-1": "The time set as a Timespan of the difference between shortening and clicking", "11-1": "The date and time the original URL was set for tracking", "10-1": "Where available the referring URL of the tracked URL, for example if the URL has been placed on a web page", "9-1": "PhoneNumber\tThe phone number the tracked URL was originally sent to", "8-1": "Where available the message Id for the original outbound message that contained the tracked URL", "7-1": "An indicator to show that prior to forwarding we have displayed our warning page, this will happen if the URL being forwarded to is listed as being a possible malware or phishing site, if this is set to true you should contact support" }, "cols": 2, "rows": 18 } [/block]