GET api/Capture/GetCaptureStatusOptions?merchantkey={merchantkey}&captureId={captureId}

Gets the status update options for the capture form.

Request Information

URI Parameters

Name	Description	Type	Additional information
merchantkey	The merchantkey.	string	Required
captureId		string	Required

Body Parameters

None.

Response Information

Resource Description

This function returns get capture.

CaptureStatusOptionsResult

Name	Description	Type	Additional information
ListCaptureStatusOptions	Gets or sets the list capture from.	Collection of CaptureStatusOptionsModel	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:

{
  "ListCaptureStatusOptions": [
    {
      "EstablishmentStatusId": 1,
      "StatusName": "sample string 2"
    },
    {
      "EstablishmentStatusId": 1,
      "StatusName": "sample string 2"
    }
  ],
  "Status": "sample string 1",
  "ErrorCode": 2,
  "ErrorText": "sample string 3"
}

multipart/form-data

Sample:

{"ListCaptureStatusOptions":[{"EstablishmentStatusId":1,"StatusName":"sample string 2"},{"EstablishmentStatusId":1,"StatusName":"sample string 2"}],"Status":"sample string 1","ErrorCode":2,"ErrorText":"sample string 3"}

application/xml, text/xml

Sample:

<CaptureStatusOptionsResult 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>
  <ListCaptureStatusOptions>
    <CaptureStatusOptionsModel>
      <EstablishmentStatusId>1</EstablishmentStatusId>
      <StatusName>sample string 2</StatusName>
    </CaptureStatusOptionsModel>
    <CaptureStatusOptionsModel>
      <EstablishmentStatusId>1</EstablishmentStatusId>
      <StatusName>sample string 2</StatusName>
    </CaptureStatusOptionsModel>
  </ListCaptureStatusOptions>
  <Status>sample string 1</Status>
</CaptureStatusOptionsResult>