POST api/Capture/SetCaptureFormBeekman?merchantkey={merchantkey}

Request Information

URI Parameters

Name	Description	Type	Additional information
merchantkey		string	Required

Body Parameters

ClsQuestionListBeekManModel

Name	Type	Additional information
siteId	integer	None.
siteName	string	None.
invNo	string	None.
guestTitle	string	None.
guestFirstname	string	None.
guestSurname	string	None.
mobileNo	string	None.
email	string	None.
ResolveCapture	string	None.
treatments	Collection of treatments	None.

Request Formats

application/json, text/json

Sample:

{
  "siteId": 1,
  "siteName": "sample string 2",
  "invNo": "sample string 3",
  "guestTitle": "sample string 4",
  "guestFirstname": "sample string 5",
  "guestSurname": "sample string 6",
  "mobileNo": "sample string 7",
  "email": "sample string 8",
  "ResolveCapture": "sample string 9",
  "treatments": [
    {
      "treatment": "sample string 1",
      "therapist": "sample string 2",
      "date": "sample string 3",
      "time": "sample string 4",
      "duration": "sample string 5"
    },
    {
      "treatment": "sample string 1",
      "therapist": "sample string 2",
      "date": "sample string 3",
      "time": "sample string 4",
      "duration": "sample string 5"
    }
  ]
}

multipart/form-data

Sample:

{"siteId":1,"siteName":"sample string 2","invNo":"sample string 3","guestTitle":"sample string 4","guestFirstname":"sample string 5","guestSurname":"sample string 6","mobileNo":"sample string 7","email":"sample string 8","ResolveCapture":"sample string 9","treatments":[{"treatment":"sample string 1","therapist":"sample string 2","date":"sample string 3","time":"sample string 4","duration":"sample string 5"},{"treatment":"sample string 1","therapist":"sample string 2","date":"sample string 3","time":"sample string 4","duration":"sample string 5"}]}

application/xml, text/xml

Sample:

<ClsQuestionListBeekManModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Models">
  <ResolveCapture>sample string 9</ResolveCapture>
  <email>sample string 8</email>
  <guestFirstname>sample string 5</guestFirstname>
  <guestSurname>sample string 6</guestSurname>
  <guestTitle>sample string 4</guestTitle>
  <invNo>sample string 3</invNo>
  <mobileNo>sample string 7</mobileNo>
  <siteId>1</siteId>
  <siteName>sample string 2</siteName>
  <treatments>
    <treatments>
      <date>sample string 3</date>
      <duration>sample string 5</duration>
      <therapist>sample string 2</therapist>
      <time>sample string 4</time>
      <treatment>sample string 1</treatment>
    </treatments>
    <treatments>
      <date>sample string 3</date>
      <duration>sample string 5</duration>
      <therapist>sample string 2</therapist>
      <time>sample string 4</time>
      <treatment>sample string 1</treatment>
    </treatments>
  </treatments>
</ClsQuestionListBeekManModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsQuestionListBeekManModel'.

Response Information

Resource Description

APIHttpResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "ErrorText": "sample string 2",
  "ErrorCode": 3
}

multipart/form-data

Sample:

{"Status":"sample string 1","ErrorText":"sample string 2","ErrorCode":3}

application/xml, text/xml

Sample:

<APIHttpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagnitudeGoldAPI.Common">
  <ErrorCode>3</ErrorCode>
  <ErrorText>sample string 2</ErrorText>
  <Status>sample string 1</Status>
</APIHttpResponse>