GET api/Capture/GetCapture?merchantkey={merchantkey}
Gets the capture.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
merchantkey |
The merchantkey. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
This function returns get capture.
CaptureResultName | Description | Type | Additional information |
---|---|---|---|
ListCaptureFrom |
Gets or sets the list capture from. |
Collection of CaptureDataTableModels |
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:
{ "ListCaptureFrom": [ { "FormDataId": 1, "EstablishmentId": 2, "EstablishmentName": "sample string 3", "CaptureId": 4, "CaptureTitle": "sample string 5", "Latitude": "sample string 6", "Longitude": "sample string 7", "ContactMasterId": "sample string 8", "ContactId": 9, "ContactQuestionsId": "sample string 10", "AppUserId": 11, "CreateDate": "2025-09-12T02:20:43.2246161+00:00", "ContactQuestions": [ { "QuestionId": 1, "QuestionTypeId": 2, "QuestionTitle": "sample string 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, "QuestionTypeId": 2, "QuestionTitle": "sample string 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" } ], "CaptureQuestions": [ { "CaptureId": 1, "QuestionId": 2, "QuestionTypeId": 3, "QuestionTitle": "sample string 4", "IsRepetitive": true, "RepetitiveGroupNo": 6, "RepetitiveGroupName": "sample string 7", "RepeatCount": 8, "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 10", "ShortName": "sample string 11" }, { "CaptureId": 1, "QuestionId": 2, "QuestionTypeId": 3, "QuestionTitle": "sample string 4", "IsRepetitive": true, "RepetitiveGroupNo": 6, "RepetitiveGroupName": "sample string 7", "RepeatCount": 8, "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 10", "ShortName": "sample string 11" } ], "CaptureStatus": [ { "CaptureStatus": "sample string 1", "StatusDateTime": "sample string 2", "AppUser": "sample string 3" }, { "CaptureStatus": "sample string 1", "StatusDateTime": "sample string 2", "AppUser": "sample string 3" } ] }, { "FormDataId": 1, "EstablishmentId": 2, "EstablishmentName": "sample string 3", "CaptureId": 4, "CaptureTitle": "sample string 5", "Latitude": "sample string 6", "Longitude": "sample string 7", "ContactMasterId": "sample string 8", "ContactId": 9, "ContactQuestionsId": "sample string 10", "AppUserId": 11, "CreateDate": "2025-09-12T02:20:43.2246161+00:00", "ContactQuestions": [ { "QuestionId": 1, "QuestionTypeId": 2, "QuestionTitle": "sample string 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, "QuestionTypeId": 2, "QuestionTitle": "sample string 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" } ], "CaptureQuestions": [ { "CaptureId": 1, "QuestionId": 2, "QuestionTypeId": 3, "QuestionTitle": "sample string 4", "IsRepetitive": true, "RepetitiveGroupNo": 6, "RepetitiveGroupName": "sample string 7", "RepeatCount": 8, "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 10", "ShortName": "sample string 11" }, { "CaptureId": 1, "QuestionId": 2, "QuestionTypeId": 3, "QuestionTitle": "sample string 4", "IsRepetitive": true, "RepetitiveGroupNo": 6, "RepetitiveGroupName": "sample string 7", "RepeatCount": 8, "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 10", "ShortName": "sample string 11" } ], "CaptureStatus": [ { "CaptureStatus": "sample string 1", "StatusDateTime": "sample string 2", "AppUser": "sample string 3" }, { "CaptureStatus": "sample string 1", "StatusDateTime": "sample string 2", "AppUser": "sample string 3" } ] } ], "Status": "sample string 1", "ErrorCode": 2, "ErrorText": "sample string 3" }
multipart/form-data
Sample:
{"ListCaptureFrom":[{"FormDataId":1,"EstablishmentId":2,"EstablishmentName":"sample string 3","CaptureId":4,"CaptureTitle":"sample string 5","Latitude":"sample string 6","Longitude":"sample string 7","ContactMasterId":"sample string 8","ContactId":9,"ContactQuestionsId":"sample string 10","AppUserId":11,"CreateDate":"2025-09-12T02:20:43.2246161+00:00","ContactQuestions":[{"QuestionId":1,"QuestionTypeId":2,"QuestionTitle":"sample string 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,"QuestionTypeId":2,"QuestionTitle":"sample string 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"}],"CaptureQuestions":[{"CaptureId":1,"QuestionId":2,"QuestionTypeId":3,"QuestionTitle":"sample string 4","IsRepetitive":true,"RepetitiveGroupNo":6,"RepetitiveGroupName":"sample string 7","RepeatCount":8,"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 10","ShortName":"sample string 11"},{"CaptureId":1,"QuestionId":2,"QuestionTypeId":3,"QuestionTitle":"sample string 4","IsRepetitive":true,"RepetitiveGroupNo":6,"RepetitiveGroupName":"sample string 7","RepeatCount":8,"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 10","ShortName":"sample string 11"}],"CaptureStatus":[{"CaptureStatus":"sample string 1","StatusDateTime":"sample string 2","AppUser":"sample string 3"},{"CaptureStatus":"sample string 1","StatusDateTime":"sample string 2","AppUser":"sample string 3"}]},{"FormDataId":1,"EstablishmentId":2,"EstablishmentName":"sample string 3","CaptureId":4,"CaptureTitle":"sample string 5","Latitude":"sample string 6","Longitude":"sample string 7","ContactMasterId":"sample string 8","ContactId":9,"ContactQuestionsId":"sample string 10","AppUserId":11,"CreateDate":"2025-09-12T02:20:43.2246161+00:00","ContactQuestions":[{"QuestionId":1,"QuestionTypeId":2,"QuestionTitle":"sample string 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,"QuestionTypeId":2,"QuestionTitle":"sample string 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"}],"CaptureQuestions":[{"CaptureId":1,"QuestionId":2,"QuestionTypeId":3,"QuestionTitle":"sample string 4","IsRepetitive":true,"RepetitiveGroupNo":6,"RepetitiveGroupName":"sample string 7","RepeatCount":8,"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 10","ShortName":"sample string 11"},{"CaptureId":1,"QuestionId":2,"QuestionTypeId":3,"QuestionTitle":"sample string 4","IsRepetitive":true,"RepetitiveGroupNo":6,"RepetitiveGroupName":"sample string 7","RepeatCount":8,"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 10","ShortName":"sample string 11"}],"CaptureStatus":[{"CaptureStatus":"sample string 1","StatusDateTime":"sample string 2","AppUser":"sample string 3"},{"CaptureStatus":"sample string 1","StatusDateTime":"sample string 2","AppUser":"sample string 3"}]}],"Status":"sample string 1","ErrorCode":2,"ErrorText":"sample string 3"}
application/xml, text/xml
Sample:
<CaptureResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Models"> <ErrorCode>2</ErrorCode> <ErrorText>sample string 3</ErrorText> <ListCaptureFrom> <CaptureDataTableModels> <AppUserId>11</AppUserId> <CaptureId>4</CaptureId> <CaptureQuestions> <CaptureQuestionsModels> <Answer>sample string 10</Answer> <CaptureId>1</CaptureId> <IsRepetitive>true</IsRepetitive> <QuestionId>2</QuestionId> <QuestionTitle>sample string 4</QuestionTitle> <QuestionTypeId>3</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <RepeatCount>8</RepeatCount> <RepetitiveGroupName>sample string 7</RepetitiveGroupName> <RepetitiveGroupNo>6</RepetitiveGroupNo> <Required>true</Required> <ShortName>sample string 11</ShortName> </CaptureQuestionsModels> <CaptureQuestionsModels> <Answer>sample string 10</Answer> <CaptureId>1</CaptureId> <IsRepetitive>true</IsRepetitive> <QuestionId>2</QuestionId> <QuestionTitle>sample string 4</QuestionTitle> <QuestionTypeId>3</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <RepeatCount>8</RepeatCount> <RepetitiveGroupName>sample string 7</RepetitiveGroupName> <RepetitiveGroupNo>6</RepetitiveGroupNo> <Required>true</Required> <ShortName>sample string 11</ShortName> </CaptureQuestionsModels> </CaptureQuestions> <CaptureStatus> <CaptureStatusModel> <AppUser>sample string 3</AppUser> <CaptureStatus>sample string 1</CaptureStatus> <StatusDateTime>sample string 2</StatusDateTime> </CaptureStatusModel> <CaptureStatusModel> <AppUser>sample string 3</AppUser> <CaptureStatus>sample string 1</CaptureStatus> <StatusDateTime>sample string 2</StatusDateTime> </CaptureStatusModel> </CaptureStatus> <CaptureTitle>sample string 5</CaptureTitle> <ContactId>9</ContactId> <ContactMasterId>sample string 8</ContactMasterId> <ContactQuestions> <ContactQuestionsModels> <Answer>sample string 5</Answer> <QuestionId>1</QuestionId> <QuestionTitle>sample string 3</QuestionTitle> <QuestionTypeId>2</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <Required>true</Required> </ContactQuestionsModels> <ContactQuestionsModels> <Answer>sample string 5</Answer> <QuestionId>1</QuestionId> <QuestionTitle>sample string 3</QuestionTitle> <QuestionTypeId>2</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <Required>true</Required> </ContactQuestionsModels> </ContactQuestions> <ContactQuestionsId>sample string 10</ContactQuestionsId> <CreateDate>2025-09-12T02:20:43.2246161+00:00</CreateDate> <EstablishmentId>2</EstablishmentId> <EstablishmentName>sample string 3</EstablishmentName> <FormDataId>1</FormDataId> <Latitude>sample string 6</Latitude> <Longitude>sample string 7</Longitude> </CaptureDataTableModels> <CaptureDataTableModels> <AppUserId>11</AppUserId> <CaptureId>4</CaptureId> <CaptureQuestions> <CaptureQuestionsModels> <Answer>sample string 10</Answer> <CaptureId>1</CaptureId> <IsRepetitive>true</IsRepetitive> <QuestionId>2</QuestionId> <QuestionTitle>sample string 4</QuestionTitle> <QuestionTypeId>3</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <RepeatCount>8</RepeatCount> <RepetitiveGroupName>sample string 7</RepetitiveGroupName> <RepetitiveGroupNo>6</RepetitiveGroupNo> <Required>true</Required> <ShortName>sample string 11</ShortName> </CaptureQuestionsModels> <CaptureQuestionsModels> <Answer>sample string 10</Answer> <CaptureId>1</CaptureId> <IsRepetitive>true</IsRepetitive> <QuestionId>2</QuestionId> <QuestionTitle>sample string 4</QuestionTitle> <QuestionTypeId>3</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <RepeatCount>8</RepeatCount> <RepetitiveGroupName>sample string 7</RepetitiveGroupName> <RepetitiveGroupNo>6</RepetitiveGroupNo> <Required>true</Required> <ShortName>sample string 11</ShortName> </CaptureQuestionsModels> </CaptureQuestions> <CaptureStatus> <CaptureStatusModel> <AppUser>sample string 3</AppUser> <CaptureStatus>sample string 1</CaptureStatus> <StatusDateTime>sample string 2</StatusDateTime> </CaptureStatusModel> <CaptureStatusModel> <AppUser>sample string 3</AppUser> <CaptureStatus>sample string 1</CaptureStatus> <StatusDateTime>sample string 2</StatusDateTime> </CaptureStatusModel> </CaptureStatus> <CaptureTitle>sample string 5</CaptureTitle> <ContactId>9</ContactId> <ContactMasterId>sample string 8</ContactMasterId> <ContactQuestions> <ContactQuestionsModels> <Answer>sample string 5</Answer> <QuestionId>1</QuestionId> <QuestionTitle>sample string 3</QuestionTitle> <QuestionTypeId>2</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <Required>true</Required> </ContactQuestionsModels> <ContactQuestionsModels> <Answer>sample string 5</Answer> <QuestionId>1</QuestionId> <QuestionTitle>sample string 3</QuestionTitle> <QuestionTypeId>2</QuestionTypeId> <QuestionsOptions xmlns:d6p1="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common"> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> <d6p1:QuestionsOptionsModels> <d6p1:OptionId>2</d6p1:OptionId> <d6p1:OptionName>sample string 3</d6p1:OptionName> <d6p1:OptionValue>sample string 4</d6p1:OptionValue> <d6p1:QuestionId>1</d6p1:QuestionId> </d6p1:QuestionsOptionsModels> </QuestionsOptions> <Required>true</Required> </ContactQuestionsModels> </ContactQuestions> <ContactQuestionsId>sample string 10</ContactQuestionsId> <CreateDate>2025-09-12T02:20:43.2246161+00:00</CreateDate> <EstablishmentId>2</EstablishmentId> <EstablishmentName>sample string 3</EstablishmentName> <FormDataId>1</FormDataId> <Latitude>sample string 6</Latitude> <Longitude>sample string 7</Longitude> </CaptureDataTableModels> </ListCaptureFrom> <Status>sample string 1</Status> </CaptureResult>