1. v3
  2. Surveys
  3. GET - 3/surveys/{surveyid}/channels/targetedpanels/urls

Definition

GET - 3/surveys/{surveyId}/channels/targetedPanels/Urls

Early access feature - Gets all the channel URLs for the targeted panel

Request information

surveyId

The id of the survey whose channel needs to be fetched.


Type integer
Additional info
Required

Response information

Returns list of channels.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of UrlManagementChannelGet
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-03T17:29:44.2146805Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "UrlId": 1,
      "Name": "sample string 3",
      "QueryName": "sample string 4",
      "OrderId": "sample string 5",
      "SurveyLinkUrl": "sample string 2",
      "CompleteUrl": "sample string 6",
      "TerminateUrl": "sample string 7",
      "OverQuotaUrl": "sample string 8"
    },
    {
      "UrlId": 1,
      "Name": "sample string 3",
      "QueryName": "sample string 4",
      "OrderId": "sample string 5",
      "SurveyLinkUrl": "sample string 2",
      "CompleteUrl": "sample string 6",
      "TerminateUrl": "sample string 7",
      "OverQuotaUrl": "sample string 8"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <UrlManagementChannelGet>
      <Name>sample string 3</Name>
      <QueryName>sample string 4</QueryName>
      <OrderId>sample string 5</OrderId>
      <CompleteUrl>sample string 6</CompleteUrl>
      <TerminateUrl>sample string 7</TerminateUrl>
      <OverQuotaUrl>sample string 8</OverQuotaUrl>
    </UrlManagementChannelGet>
    <UrlManagementChannelGet>
      <Name>sample string 3</Name>
      <QueryName>sample string 4</QueryName>
      <OrderId>sample string 5</OrderId>
      <CompleteUrl>sample string 6</CompleteUrl>
      <TerminateUrl>sample string 7</TerminateUrl>
      <OverQuotaUrl>sample string 8</OverQuotaUrl>
    </UrlManagementChannelGet>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-03T17:29:44.2146805+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>