GET api/Capture/GetCaptureForm?merchantkey={merchantkey}&activityID={activityID}

Gets capture form details for a specific activity.

Request Information

URI Parameters

Name	Description	Type	Additional information
merchantkey	The merchantkey.	string	Required
activityID	The activity Identifier.	string	Required

Body Parameters

None.

Response Information

Resource Description

This function returns the capture form details for an acitivty.

CaptureFormResult

Name	Description	Type	Additional information
CaptureFormDetails	Gets or sets the list capture from.	CaptureFormCreateDataTableModel	None.
Status	Gets or sets the status.	string	None.
ErrorCode	Gets or sets the error code.	integer	None.
ErrorText	Gets or sets the error text.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CaptureFormDetails": {
    "EstablishmentId": "sample string 1",
    "ActivityName": "sample string 2",
    "ActivityId": "sample string 3",
    "Latitude": "sample string 4",
    "Longitude": "sample string 5",
    "ContactMasterId": "sample string 6",
    "IsContactGroup": 7,
    "UseDefaultContact": 8,
    "AppUserId": 9,
    "sendCaptureNotification": 10,
    "CreateDate": "2025-09-12T02:18:25.2898773+00:00",
    "Questions": [
      {
        "QuestionId": 1,
        "QuestionTitle": "sample string 2",
        "QuestionTypeId": 3,
        "QuestionsOptions": [
          {
            "QuestionId": 1,
            "OptionId": 2,
            "OptionName": "sample string 3",
            "OptionValue": "sample string 4"
          },
          {
            "QuestionId": 1,
            "OptionId": 2,
            "OptionName": "sample string 3",
            "OptionValue": "sample string 4"
          }
        ],
        "Required": true,
        "Answer": "sample string 5"
      },
      {
        "QuestionId": 1,
        "QuestionTitle": "sample string 2",
        "QuestionTypeId": 3,
        "QuestionsOptions": [
          {
            "QuestionId": 1,
            "OptionId": 2,
            "OptionName": "sample string 3",
            "OptionValue": "sample string 4"
          },
          {
            "QuestionId": 1,
            "OptionId": 2,
            "OptionName": "sample string 3",
            "OptionValue": "sample string 4"
          }
        ],
        "Required": true,
        "Answer": "sample string 5"
      }
    ]
  },
  "Status": "sample string 1",
  "ErrorCode": 2,
  "ErrorText": "sample string 3"
}

multipart/form-data

Sample:

{"CaptureFormDetails":{"EstablishmentId":"sample string 1","ActivityName":"sample string 2","ActivityId":"sample string 3","Latitude":"sample string 4","Longitude":"sample string 5","ContactMasterId":"sample string 6","IsContactGroup":7,"UseDefaultContact":8,"AppUserId":9,"sendCaptureNotification":10,"CreateDate":"2025-09-12T02:18:25.2898773+00:00","Questions":[{"QuestionId":1,"QuestionTitle":"sample string 2","QuestionTypeId":3,"QuestionsOptions":[{"QuestionId":1,"OptionId":2,"OptionName":"sample string 3","OptionValue":"sample string 4"},{"QuestionId":1,"OptionId":2,"OptionName":"sample string 3","OptionValue":"sample string 4"}],"Required":true,"Answer":"sample string 5"},{"QuestionId":1,"QuestionTitle":"sample string 2","QuestionTypeId":3,"QuestionsOptions":[{"QuestionId":1,"OptionId":2,"OptionName":"sample string 3","OptionValue":"sample string 4"},{"QuestionId":1,"OptionId":2,"OptionName":"sample string 3","OptionValue":"sample string 4"}],"Required":true,"Answer":"sample string 5"}]},"Status":"sample string 1","ErrorCode":2,"ErrorText":"sample string 3"}

application/xml, text/xml

Sample:

<CaptureFormResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Models">
  <CaptureFormDetails>
    <ActivityId>sample string 3</ActivityId>
    <ActivityName>sample string 2</ActivityName>
    <AppUserId>9</AppUserId>
    <ContactMasterId>sample string 6</ContactMasterId>
    <CreateDate>2025-09-12T02:18:25.2898773+00:00</CreateDate>
    <EstablishmentId>sample string 1</EstablishmentId>
    <IsContactGroup>7</IsContactGroup>
    <Latitude>sample string 4</Latitude>
    <Longitude>sample string 5</Longitude>
    <Questions>
      <CaptureQuestionsFilteredModels>
        <Answer>sample string 5</Answer>
        <QuestionId>1</QuestionId>
        <QuestionTitle>sample string 2</QuestionTitle>
        <QuestionTypeId>3</QuestionTypeId>
        <QuestionsOptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common">
          <d5p1:QuestionsOptionsModels>
            <d5p1:OptionId>2</d5p1:OptionId>
            <d5p1:OptionName>sample string 3</d5p1:OptionName>
            <d5p1:OptionValue>sample string 4</d5p1:OptionValue>
            <d5p1:QuestionId>1</d5p1:QuestionId>
          </d5p1:QuestionsOptionsModels>
          <d5p1:QuestionsOptionsModels>
            <d5p1:OptionId>2</d5p1:OptionId>
            <d5p1:OptionName>sample string 3</d5p1:OptionName>
            <d5p1:OptionValue>sample string 4</d5p1:OptionValue>
            <d5p1:QuestionId>1</d5p1:QuestionId>
          </d5p1:QuestionsOptionsModels>
        </QuestionsOptions>
        <Required>true</Required>
      </CaptureQuestionsFilteredModels>
      <CaptureQuestionsFilteredModels>
        <Answer>sample string 5</Answer>
        <QuestionId>1</QuestionId>
        <QuestionTitle>sample string 2</QuestionTitle>
        <QuestionTypeId>3</QuestionTypeId>
        <QuestionsOptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common">
          <d5p1:QuestionsOptionsModels>
            <d5p1:OptionId>2</d5p1:OptionId>
            <d5p1:OptionName>sample string 3</d5p1:OptionName>
            <d5p1:OptionValue>sample string 4</d5p1:OptionValue>
            <d5p1:QuestionId>1</d5p1:QuestionId>
          </d5p1:QuestionsOptionsModels>
          <d5p1:QuestionsOptionsModels>
            <d5p1:OptionId>2</d5p1:OptionId>
            <d5p1:OptionName>sample string 3</d5p1:OptionName>
            <d5p1:OptionValue>sample string 4</d5p1:OptionValue>
            <d5p1:QuestionId>1</d5p1:QuestionId>
          </d5p1:QuestionsOptionsModels>
        </QuestionsOptions>
        <Required>true</Required>
      </CaptureQuestionsFilteredModels>
    </Questions>
    <UseDefaultContact>8</UseDefaultContact>
    <sendCaptureNotification>10</sendCaptureNotification>
  </CaptureFormDetails>
  <ErrorCode>2</ErrorCode>
  <ErrorText>sample string 3</ErrorText>
  <Status>sample string 1</Status>
</CaptureFormResult>