GET api/Capture/GetCaptureData?merchantkey={merchantkey}&fromDate={fromDate}&toDate={toDate}&captureId={captureId}&activityId={activityId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
merchantkey

string

Required

fromDate

string

Required

toDate

string

Required

captureId

string

Default value is 0

activityId

string

Default value is 0

Body Parameters

None.

Response Information

Resource Description

CaptureDataResult
NameDescriptionTypeAdditional information
CaptureData

Gets or sets the capture data.

Collection of CaptureModel

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:
{
  "CaptureData": [
    {
      "ReportId": 1,
      "ActivityId": 2,
      "ActivityName": "sample string 3",
      "EstablishmentId": 4,
      "EstablishmentName": "sample string 5",
      "CaptureId": 6,
      "CaptureFormTitle": "sample string 7",
      "StatusName": "sample string 8",
      "StatusDate": "sample string 9",
      "AppUser": "sample string 10",
      "OutStanding": true,
      "ReadBy": "sample string 12",
      "Latitude": "sample string 13",
      "Longitude": "sample string 14",
      "TimeOffSet": 15,
      "Positive": "sample string 16",
      "EI": 17.0,
      "Resolved": "sample string 18",
      "Transferred": true,
      "Actioned": true,
      "SenderCellNo": "sample string 21",
      "SubmittedForGroup": true,
      "PI": 23.0,
      "Narration": "sample string 24",
      "Recursion": true,
      "EscalationSendDate": "sample string 26",
      "CreatedDate": "sample string 27",
      "CreatedBy": "sample string 28",
      "CaptureStatus": "sample string 29",
      "StatusDateTime": "sample string 30",
      "QuestionsAnswer": [
        {
          "AnswerMasterId": 1,
          "AnswerId": 2,
          "QuestionId": 3,
          "QuestionType": "sample string 4",
          "Question": "sample string 5",
          "Answer": "sample string 6",
          "Weight": 7.0,
          "QPI": 8.0,
          "IsRepetitive": true,
          "RepetitiveGroupNo": 10,
          "RepetitiveGroupName": "sample string 11",
          "RepeatCount": 12,
          "SectionNo": 13,
          "SectionName": "sample string 14"
        },
        {
          "AnswerMasterId": 1,
          "AnswerId": 2,
          "QuestionId": 3,
          "QuestionType": "sample string 4",
          "Question": "sample string 5",
          "Answer": "sample string 6",
          "Weight": 7.0,
          "QPI": 8.0,
          "IsRepetitive": true,
          "RepetitiveGroupNo": 10,
          "RepetitiveGroupName": "sample string 11",
          "RepeatCount": 12,
          "SectionNo": 13,
          "SectionName": "sample string 14"
        }
      ],
      "FormChats": [
        {
          "ReportId": 1,
          "ChatId": 2,
          "Conversation": "sample string 3",
          "Sender": "sample string 4",
          "CreatedDate": "sample string 5",
          "ReminderSet": "sample string 6",
          "Attachment": "sample string 7",
          "FilePath": "sample string 8",
          "IsRead": true
        },
        {
          "ReportId": 1,
          "ChatId": 2,
          "Conversation": "sample string 3",
          "Sender": "sample string 4",
          "CreatedDate": "sample string 5",
          "ReminderSet": "sample string 6",
          "Attachment": "sample string 7",
          "FilePath": "sample string 8",
          "IsRead": true
        }
      ]
    },
    {
      "ReportId": 1,
      "ActivityId": 2,
      "ActivityName": "sample string 3",
      "EstablishmentId": 4,
      "EstablishmentName": "sample string 5",
      "CaptureId": 6,
      "CaptureFormTitle": "sample string 7",
      "StatusName": "sample string 8",
      "StatusDate": "sample string 9",
      "AppUser": "sample string 10",
      "OutStanding": true,
      "ReadBy": "sample string 12",
      "Latitude": "sample string 13",
      "Longitude": "sample string 14",
      "TimeOffSet": 15,
      "Positive": "sample string 16",
      "EI": 17.0,
      "Resolved": "sample string 18",
      "Transferred": true,
      "Actioned": true,
      "SenderCellNo": "sample string 21",
      "SubmittedForGroup": true,
      "PI": 23.0,
      "Narration": "sample string 24",
      "Recursion": true,
      "EscalationSendDate": "sample string 26",
      "CreatedDate": "sample string 27",
      "CreatedBy": "sample string 28",
      "CaptureStatus": "sample string 29",
      "StatusDateTime": "sample string 30",
      "QuestionsAnswer": [
        {
          "AnswerMasterId": 1,
          "AnswerId": 2,
          "QuestionId": 3,
          "QuestionType": "sample string 4",
          "Question": "sample string 5",
          "Answer": "sample string 6",
          "Weight": 7.0,
          "QPI": 8.0,
          "IsRepetitive": true,
          "RepetitiveGroupNo": 10,
          "RepetitiveGroupName": "sample string 11",
          "RepeatCount": 12,
          "SectionNo": 13,
          "SectionName": "sample string 14"
        },
        {
          "AnswerMasterId": 1,
          "AnswerId": 2,
          "QuestionId": 3,
          "QuestionType": "sample string 4",
          "Question": "sample string 5",
          "Answer": "sample string 6",
          "Weight": 7.0,
          "QPI": 8.0,
          "IsRepetitive": true,
          "RepetitiveGroupNo": 10,
          "RepetitiveGroupName": "sample string 11",
          "RepeatCount": 12,
          "SectionNo": 13,
          "SectionName": "sample string 14"
        }
      ],
      "FormChats": [
        {
          "ReportId": 1,
          "ChatId": 2,
          "Conversation": "sample string 3",
          "Sender": "sample string 4",
          "CreatedDate": "sample string 5",
          "ReminderSet": "sample string 6",
          "Attachment": "sample string 7",
          "FilePath": "sample string 8",
          "IsRead": true
        },
        {
          "ReportId": 1,
          "ChatId": 2,
          "Conversation": "sample string 3",
          "Sender": "sample string 4",
          "CreatedDate": "sample string 5",
          "ReminderSet": "sample string 6",
          "Attachment": "sample string 7",
          "FilePath": "sample string 8",
          "IsRead": true
        }
      ]
    }
  ],
  "Status": "sample string 1",
  "ErrorCode": 2,
  "ErrorText": "sample string 3"
}

multipart/form-data

Sample:
{"CaptureData":[{"ReportId":1,"ActivityId":2,"ActivityName":"sample string 3","EstablishmentId":4,"EstablishmentName":"sample string 5","CaptureId":6,"CaptureFormTitle":"sample string 7","StatusName":"sample string 8","StatusDate":"sample string 9","AppUser":"sample string 10","OutStanding":true,"ReadBy":"sample string 12","Latitude":"sample string 13","Longitude":"sample string 14","TimeOffSet":15,"Positive":"sample string 16","EI":17.0,"Resolved":"sample string 18","Transferred":true,"Actioned":true,"SenderCellNo":"sample string 21","SubmittedForGroup":true,"PI":23.0,"Narration":"sample string 24","Recursion":true,"EscalationSendDate":"sample string 26","CreatedDate":"sample string 27","CreatedBy":"sample string 28","CaptureStatus":"sample string 29","StatusDateTime":"sample string 30","QuestionsAnswer":[{"AnswerMasterId":1,"AnswerId":2,"QuestionId":3,"QuestionType":"sample string 4","Question":"sample string 5","Answer":"sample string 6","Weight":7.0,"QPI":8.0,"IsRepetitive":true,"RepetitiveGroupNo":10,"RepetitiveGroupName":"sample string 11","RepeatCount":12,"SectionNo":13,"SectionName":"sample string 14"},{"AnswerMasterId":1,"AnswerId":2,"QuestionId":3,"QuestionType":"sample string 4","Question":"sample string 5","Answer":"sample string 6","Weight":7.0,"QPI":8.0,"IsRepetitive":true,"RepetitiveGroupNo":10,"RepetitiveGroupName":"sample string 11","RepeatCount":12,"SectionNo":13,"SectionName":"sample string 14"}],"FormChats":[{"ReportId":1,"ChatId":2,"Conversation":"sample string 3","Sender":"sample string 4","CreatedDate":"sample string 5","ReminderSet":"sample string 6","Attachment":"sample string 7","FilePath":"sample string 8","IsRead":true},{"ReportId":1,"ChatId":2,"Conversation":"sample string 3","Sender":"sample string 4","CreatedDate":"sample string 5","ReminderSet":"sample string 6","Attachment":"sample string 7","FilePath":"sample string 8","IsRead":true}]},{"ReportId":1,"ActivityId":2,"ActivityName":"sample string 3","EstablishmentId":4,"EstablishmentName":"sample string 5","CaptureId":6,"CaptureFormTitle":"sample string 7","StatusName":"sample string 8","StatusDate":"sample string 9","AppUser":"sample string 10","OutStanding":true,"ReadBy":"sample string 12","Latitude":"sample string 13","Longitude":"sample string 14","TimeOffSet":15,"Positive":"sample string 16","EI":17.0,"Resolved":"sample string 18","Transferred":true,"Actioned":true,"SenderCellNo":"sample string 21","SubmittedForGroup":true,"PI":23.0,"Narration":"sample string 24","Recursion":true,"EscalationSendDate":"sample string 26","CreatedDate":"sample string 27","CreatedBy":"sample string 28","CaptureStatus":"sample string 29","StatusDateTime":"sample string 30","QuestionsAnswer":[{"AnswerMasterId":1,"AnswerId":2,"QuestionId":3,"QuestionType":"sample string 4","Question":"sample string 5","Answer":"sample string 6","Weight":7.0,"QPI":8.0,"IsRepetitive":true,"RepetitiveGroupNo":10,"RepetitiveGroupName":"sample string 11","RepeatCount":12,"SectionNo":13,"SectionName":"sample string 14"},{"AnswerMasterId":1,"AnswerId":2,"QuestionId":3,"QuestionType":"sample string 4","Question":"sample string 5","Answer":"sample string 6","Weight":7.0,"QPI":8.0,"IsRepetitive":true,"RepetitiveGroupNo":10,"RepetitiveGroupName":"sample string 11","RepeatCount":12,"SectionNo":13,"SectionName":"sample string 14"}],"FormChats":[{"ReportId":1,"ChatId":2,"Conversation":"sample string 3","Sender":"sample string 4","CreatedDate":"sample string 5","ReminderSet":"sample string 6","Attachment":"sample string 7","FilePath":"sample string 8","IsRead":true},{"ReportId":1,"ChatId":2,"Conversation":"sample string 3","Sender":"sample string 4","CreatedDate":"sample string 5","ReminderSet":"sample string 6","Attachment":"sample string 7","FilePath":"sample string 8","IsRead":true}]}],"Status":"sample string 1","ErrorCode":2,"ErrorText":"sample string 3"}

application/xml, text/xml

Sample:
<CaptureDataResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Models">
  <CaptureData>
    <CaptureModel>
      <Actioned>true</Actioned>
      <ActivityId>2</ActivityId>
      <ActivityName>sample string 3</ActivityName>
      <AppUser>sample string 10</AppUser>
      <CaptureFormTitle>sample string 7</CaptureFormTitle>
      <CaptureId>6</CaptureId>
      <CaptureStatus>sample string 29</CaptureStatus>
      <CreatedBy>sample string 28</CreatedBy>
      <CreatedDate>sample string 27</CreatedDate>
      <EI>17</EI>
      <EscalationSendDate>sample string 26</EscalationSendDate>
      <EstablishmentId>4</EstablishmentId>
      <EstablishmentName>sample string 5</EstablishmentName>
      <FormChats>
        <CaptureFormChats>
          <Attachment>sample string 7</Attachment>
          <ChatId>2</ChatId>
          <Conversation>sample string 3</Conversation>
          <CreatedDate>sample string 5</CreatedDate>
          <FilePath>sample string 8</FilePath>
          <IsRead>true</IsRead>
          <ReminderSet>sample string 6</ReminderSet>
          <ReportId>1</ReportId>
          <Sender>sample string 4</Sender>
        </CaptureFormChats>
        <CaptureFormChats>
          <Attachment>sample string 7</Attachment>
          <ChatId>2</ChatId>
          <Conversation>sample string 3</Conversation>
          <CreatedDate>sample string 5</CreatedDate>
          <FilePath>sample string 8</FilePath>
          <IsRead>true</IsRead>
          <ReminderSet>sample string 6</ReminderSet>
          <ReportId>1</ReportId>
          <Sender>sample string 4</Sender>
        </CaptureFormChats>
      </FormChats>
      <Latitude>sample string 13</Latitude>
      <Longitude>sample string 14</Longitude>
      <Narration>sample string 24</Narration>
      <OutStanding>true</OutStanding>
      <PI>23</PI>
      <Positive>sample string 16</Positive>
      <QuestionsAnswer>
        <CaptureQuestionAnswer>
          <Answer>sample string 6</Answer>
          <AnswerId>2</AnswerId>
          <AnswerMasterId>1</AnswerMasterId>
          <IsRepetitive>true</IsRepetitive>
          <QPI>8</QPI>
          <Question>sample string 5</Question>
          <QuestionId>3</QuestionId>
          <QuestionType>sample string 4</QuestionType>
          <RepeatCount>12</RepeatCount>
          <RepetitiveGroupName>sample string 11</RepetitiveGroupName>
          <RepetitiveGroupNo>10</RepetitiveGroupNo>
          <SectionName>sample string 14</SectionName>
          <SectionNo>13</SectionNo>
          <Weight>7</Weight>
        </CaptureQuestionAnswer>
        <CaptureQuestionAnswer>
          <Answer>sample string 6</Answer>
          <AnswerId>2</AnswerId>
          <AnswerMasterId>1</AnswerMasterId>
          <IsRepetitive>true</IsRepetitive>
          <QPI>8</QPI>
          <Question>sample string 5</Question>
          <QuestionId>3</QuestionId>
          <QuestionType>sample string 4</QuestionType>
          <RepeatCount>12</RepeatCount>
          <RepetitiveGroupName>sample string 11</RepetitiveGroupName>
          <RepetitiveGroupNo>10</RepetitiveGroupNo>
          <SectionName>sample string 14</SectionName>
          <SectionNo>13</SectionNo>
          <Weight>7</Weight>
        </CaptureQuestionAnswer>
      </QuestionsAnswer>
      <ReadBy>sample string 12</ReadBy>
      <Recursion>true</Recursion>
      <ReportId>1</ReportId>
      <Resolved>sample string 18</Resolved>
      <SenderCellNo>sample string 21</SenderCellNo>
      <StatusDate>sample string 9</StatusDate>
      <StatusDateTime>sample string 30</StatusDateTime>
      <StatusName>sample string 8</StatusName>
      <SubmittedForGroup>true</SubmittedForGroup>
      <TimeOffSet>15</TimeOffSet>
      <Transferred>true</Transferred>
    </CaptureModel>
    <CaptureModel>
      <Actioned>true</Actioned>
      <ActivityId>2</ActivityId>
      <ActivityName>sample string 3</ActivityName>
      <AppUser>sample string 10</AppUser>
      <CaptureFormTitle>sample string 7</CaptureFormTitle>
      <CaptureId>6</CaptureId>
      <CaptureStatus>sample string 29</CaptureStatus>
      <CreatedBy>sample string 28</CreatedBy>
      <CreatedDate>sample string 27</CreatedDate>
      <EI>17</EI>
      <EscalationSendDate>sample string 26</EscalationSendDate>
      <EstablishmentId>4</EstablishmentId>
      <EstablishmentName>sample string 5</EstablishmentName>
      <FormChats>
        <CaptureFormChats>
          <Attachment>sample string 7</Attachment>
          <ChatId>2</ChatId>
          <Conversation>sample string 3</Conversation>
          <CreatedDate>sample string 5</CreatedDate>
          <FilePath>sample string 8</FilePath>
          <IsRead>true</IsRead>
          <ReminderSet>sample string 6</ReminderSet>
          <ReportId>1</ReportId>
          <Sender>sample string 4</Sender>
        </CaptureFormChats>
        <CaptureFormChats>
          <Attachment>sample string 7</Attachment>
          <ChatId>2</ChatId>
          <Conversation>sample string 3</Conversation>
          <CreatedDate>sample string 5</CreatedDate>
          <FilePath>sample string 8</FilePath>
          <IsRead>true</IsRead>
          <ReminderSet>sample string 6</ReminderSet>
          <ReportId>1</ReportId>
          <Sender>sample string 4</Sender>
        </CaptureFormChats>
      </FormChats>
      <Latitude>sample string 13</Latitude>
      <Longitude>sample string 14</Longitude>
      <Narration>sample string 24</Narration>
      <OutStanding>true</OutStanding>
      <PI>23</PI>
      <Positive>sample string 16</Positive>
      <QuestionsAnswer>
        <CaptureQuestionAnswer>
          <Answer>sample string 6</Answer>
          <AnswerId>2</AnswerId>
          <AnswerMasterId>1</AnswerMasterId>
          <IsRepetitive>true</IsRepetitive>
          <QPI>8</QPI>
          <Question>sample string 5</Question>
          <QuestionId>3</QuestionId>
          <QuestionType>sample string 4</QuestionType>
          <RepeatCount>12</RepeatCount>
          <RepetitiveGroupName>sample string 11</RepetitiveGroupName>
          <RepetitiveGroupNo>10</RepetitiveGroupNo>
          <SectionName>sample string 14</SectionName>
          <SectionNo>13</SectionNo>
          <Weight>7</Weight>
        </CaptureQuestionAnswer>
        <CaptureQuestionAnswer>
          <Answer>sample string 6</Answer>
          <AnswerId>2</AnswerId>
          <AnswerMasterId>1</AnswerMasterId>
          <IsRepetitive>true</IsRepetitive>
          <QPI>8</QPI>
          <Question>sample string 5</Question>
          <QuestionId>3</QuestionId>
          <QuestionType>sample string 4</QuestionType>
          <RepeatCount>12</RepeatCount>
          <RepetitiveGroupName>sample string 11</RepetitiveGroupName>
          <RepetitiveGroupNo>10</RepetitiveGroupNo>
          <SectionName>sample string 14</SectionName>
          <SectionNo>13</SectionNo>
          <Weight>7</Weight>
        </CaptureQuestionAnswer>
      </QuestionsAnswer>
      <ReadBy>sample string 12</ReadBy>
      <Recursion>true</Recursion>
      <ReportId>1</ReportId>
      <Resolved>sample string 18</Resolved>
      <SenderCellNo>sample string 21</SenderCellNo>
      <StatusDate>sample string 9</StatusDate>
      <StatusDateTime>sample string 30</StatusDateTime>
      <StatusName>sample string 8</StatusName>
      <SubmittedForGroup>true</SubmittedForGroup>
      <TimeOffSet>15</TimeOffSet>
      <Transferred>true</Transferred>
    </CaptureModel>
  </CaptureData>
  <ErrorCode>2</ErrorCode>
  <ErrorText>sample string 3</ErrorText>
  <Status>sample string 1</Status>
</CaptureDataResult>