Early access feature
- Creates channel URL for the targeted panel in a survey
Name | Description | Type | Additional information |
---|---|---|---|
surveyId
The id of the survey for which channel needs to be created.
Type
integer
Additional info
Required
|
|||
surveyId |
The id of the survey for which channel needs to be created. |
integer |
Required |
Channel URL details which needs to be created.
Name | Description | Type | Additional information |
---|---|---|---|
Name
Channel name of the panel
Type
string
Additional info
Required |
|||
Name |
Channel name of the panel |
string |
Required |
QueryName
Query string parameter for panel
Type
string
Additional info
If null or empty will defaults to "pid" |
|||
QueryName |
Query string parameter for panel |
string |
If null or empty will defaults to "pid" |
OrderId
Order Id of the channel
Type
string
|
|||
OrderId |
Order Id of the channel |
string | |
CompleteUrl
Complete URL for the panel
Type
string
|
|||
CompleteUrl |
Complete URL for the panel |
string | |
TerminateUrl
Terminate/disqualified URL for the panel
Type
string
|
|||
TerminateUrl |
Terminate/disqualified URL for the panel |
string | |
OverQuotaUrl
Over quota URL for the panel
Type
string
|
|||
OverQuotaUrl |
Over quota URL for the panel |
string |
{ "Name": "sample string 2", "QueryName": "sample string 3", "OrderId": "sample string 4", "CompleteUrl": "sample string 6", "TerminateUrl": "sample string 7", "OverQuotaUrl": "sample string 8" }
<UrlManagementChannel xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Name>sample string 2</Name> <QueryName>sample string 3</QueryName> <OrderId>sample string 4</OrderId> <CompleteUrl>sample string 6</CompleteUrl> <TerminateUrl>sample string 7</TerminateUrl> <OverQuotaUrl>sample string 8</OverQuotaUrl> </UrlManagementChannel>
Returns channel Id of channel created.
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data |
The actual data returned by the request. |
UrlManagementChannelResult | |
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. |
Hateoas |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-09-07T23:38:26.613967Z", "IsFiltered": true }, "Data": { "Succeeded": true, "FailureMessage": "sample string 2", "UrlId": 3 } }
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Data> <FailureMessage>sample string 2</FailureMessage> <Succeeded>true</Succeeded> <UrlId>3</UrlId> </Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-09-07T23:38:26.613967+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>