1. v3
  2. Surveys
  3. GET - 3/surveys/{surveyid}/pages/{pagenumber}/branching

Definition

GET - 3/surveys/{surveyId}/pages/{pageNumber}/branching

Early access feature - Gets page branch logic.

Required roles: Survey (write)

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required
pageNumber

The id of a survey.


Type integer
Additional info
Required

Response information

Returns branching of a page.


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 LogicsRead
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-11-21T15:53:17.2439468Z",
    "IsFiltered": true
  },
  "Data": {
    "Logics": [
      {
        "LogicOperatorId": 1,
        "Items": [
          {
            "MetadataTypeId": 64,
            "OperatorId": 2,
            "QuestionId": 1,
            "ResponseId": 1,
            "Value": "sample string 3",
            "QueryStringParameter": "sample string 4",
            "LogicItemId": 1,
            "IsDeleted": true
          },
          {
            "MetadataTypeId": 64,
            "OperatorId": 2,
            "QuestionId": 1,
            "ResponseId": 1,
            "Value": "sample string 3",
            "QueryStringParameter": "sample string 4",
            "LogicItemId": 1,
            "IsDeleted": true
          }
        ],
        "GotoPage": 1,
        "GotoURL": {
          "RespondentStatus": 1,
          "Url": "sample string 1"
        },
        "LogicId": 2
      },
      {
        "LogicOperatorId": 1,
        "Items": [
          {
            "MetadataTypeId": 64,
            "OperatorId": 2,
            "QuestionId": 1,
            "ResponseId": 1,
            "Value": "sample string 3",
            "QueryStringParameter": "sample string 4",
            "LogicItemId": 1,
            "IsDeleted": true
          },
          {
            "MetadataTypeId": 64,
            "OperatorId": 2,
            "QuestionId": 1,
            "ResponseId": 1,
            "Value": "sample string 3",
            "QueryStringParameter": "sample string 4",
            "LogicItemId": 1,
            "IsDeleted": true
          }
        ],
        "GotoPage": 1,
        "GotoURL": {
          "RespondentStatus": 1,
          "Url": "sample string 1"
        },
        "LogicId": 2
      }
    ],
    "ElsePage": {
      "ElsePageLogicId": 1,
      "ElseGotoPage": 2,
      "ElseGotoURL": {
        "RespondentStatus": 1,
        "Url": "sample string 1"
      }
    }
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <Logics>
      <LogicUpdate>
        <LogicOperatorId>AND</LogicOperatorId>
        <Items>
          <LogicItemUpdate>
            <MetadataTypeId>64</MetadataTypeId>
            <OperatorId>2</OperatorId>
            <QuestionId>1</QuestionId>
            <ResponseId>1</ResponseId>
            <Value>sample string 3</Value>
            <QueryStringParameter>sample string 4</QueryStringParameter>
            <LogicItemId>1</LogicItemId>
            <IsDeleted>true</IsDeleted>
          </LogicItemUpdate>
          <LogicItemUpdate>
            <MetadataTypeId>64</MetadataTypeId>
            <OperatorId>2</OperatorId>
            <QuestionId>1</QuestionId>
            <ResponseId>1</ResponseId>
            <Value>sample string 3</Value>
            <QueryStringParameter>sample string 4</QueryStringParameter>
            <LogicItemId>1</LogicItemId>
            <IsDeleted>true</IsDeleted>
          </LogicItemUpdate>
        </Items>
        <GotoPage>1</GotoPage>
        <GotoURL>
          <RespondentStatus>ReachedEnd</RespondentStatus>
          <Url>sample string 1</Url>
        </GotoURL>
        <LogicId>2</LogicId>
      </LogicUpdate>
      <LogicUpdate>
        <LogicOperatorId>AND</LogicOperatorId>
        <Items>
          <LogicItemUpdate>
            <MetadataTypeId>64</MetadataTypeId>
            <OperatorId>2</OperatorId>
            <QuestionId>1</QuestionId>
            <ResponseId>1</ResponseId>
            <Value>sample string 3</Value>
            <QueryStringParameter>sample string 4</QueryStringParameter>
            <LogicItemId>1</LogicItemId>
            <IsDeleted>true</IsDeleted>
          </LogicItemUpdate>
          <LogicItemUpdate>
            <MetadataTypeId>64</MetadataTypeId>
            <OperatorId>2</OperatorId>
            <QuestionId>1</QuestionId>
            <ResponseId>1</ResponseId>
            <Value>sample string 3</Value>
            <QueryStringParameter>sample string 4</QueryStringParameter>
            <LogicItemId>1</LogicItemId>
            <IsDeleted>true</IsDeleted>
          </LogicItemUpdate>
        </Items>
        <GotoPage>1</GotoPage>
        <GotoURL>
          <RespondentStatus>ReachedEnd</RespondentStatus>
          <Url>sample string 1</Url>
        </GotoURL>
        <LogicId>2</LogicId>
      </LogicUpdate>
    </Logics>
    <ElsePage xmlns:d3p1="http://schemas.datacontract.org/2004/07/CheckMarket.Common.APIModels">
      <d3p1:ElseGotoPage>2</d3p1:ElseGotoPage>
      <d3p1:ElseGotoURL>
        <RespondentStatus>ReachedEnd</RespondentStatus>
        <Url>sample string 1</Url>
      </d3p1:ElseGotoURL>
      <d3p1:ElsePageLogicId>1</d3p1:ElsePageLogicId>
    </ElsePage>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T15:53:17.2439468+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>