POST ControlCheck

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Cs	ClientSecurity	None.
BranchId	integer	None.
Terminal	string	None.
PhoneNumber	string	None.
Guid	string	None.
TotalPrice	decimal number	None.
OrderType	string	None.
DontWin	boolean	None.
Date	LdateTime	None.
Details	Collection of LoyaltyCheckDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "Cs": {
    "UserName": "sample string 1",
    "Pass": "sample string 2",
    "CompanyKey": "sample string 3"
  },
  "BranchId": 1,
  "Terminal": "sample string 2",
  "PhoneNumber": "sample string 3",
  "Guid": "sample string 4",
  "TotalPrice": 5.1,
  "OrderType": "sample string 6",
  "DontWin": true,
  "Date": {
    "Year": 1,
    "Month": 2,
    "Day": 3,
    "Hour": 4,
    "Minute": 5,
    "Second": 6,
    "Value": "0001-02-03T04:05:06",
    "NullableValue": "0001-02-03T04:05:06"
  },
  "Details": [
    {
      "ItemGroupNo": 1,
      "ItemNo": 2,
      "ItemName": "sample string 3",
      "Count": 4.1,
      "TotalPrice": 5.1,
      "ItemType": 0,
      "GiftGuid": "sample string 6",
      "FramesId": [
        1,
        2
      ],
      "NonDiscountedPrice": 7.1
    },
    {
      "ItemGroupNo": 1,
      "ItemNo": 2,
      "ItemName": "sample string 3",
      "Count": 4.1,
      "TotalPrice": 5.1,
      "ItemType": 0,
      "GiftGuid": "sample string 6",
      "FramesId": [
        1,
        2
      ],
      "NonDiscountedPrice": 7.1
    }
  ]
}

application/xml, text/xml

Sample:

<ControlCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Integration.External">
  <BranchId>1</BranchId>
  <Cs>
    <CompanyKey>sample string 3</CompanyKey>
    <Pass>sample string 2</Pass>
    <UserName>sample string 1</UserName>
  </Cs>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Helpers">
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Year>1</d2p1:Year>
  </Date>
  <Details>
    <LoyaltyCheckDetail>
      <Count>4.1</Count>
      <FramesId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FramesId>
      <GiftGuid>sample string 6</GiftGuid>
      <ItemGroupNo>1</ItemGroupNo>
      <ItemName>sample string 3</ItemName>
      <ItemNo>2</ItemNo>
      <ItemType>Item</ItemType>
      <NonDiscountedPrice>7.1</NonDiscountedPrice>
      <TotalPrice>5.1</TotalPrice>
    </LoyaltyCheckDetail>
    <LoyaltyCheckDetail>
      <Count>4.1</Count>
      <FramesId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FramesId>
      <GiftGuid>sample string 6</GiftGuid>
      <ItemGroupNo>1</ItemGroupNo>
      <ItemName>sample string 3</ItemName>
      <ItemNo>2</ItemNo>
      <ItemType>Item</ItemType>
      <NonDiscountedPrice>7.1</NonDiscountedPrice>
      <TotalPrice>5.1</TotalPrice>
    </LoyaltyCheckDetail>
  </Details>
  <DontWin>true</DontWin>
  <Guid>sample string 4</Guid>
  <OrderType>sample string 6</OrderType>
  <PhoneNumber>sample string 3</PhoneNumber>
  <Terminal>sample string 2</Terminal>
  <TotalPrice>5.1</TotalPrice>
</ControlCheckRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ControlCheckResult

Name	Type	Additional information
Result	ServiceResult	None.
ResultMessage	string	None.
DiscountTotal	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": 0,
  "ResultMessage": "sample string 1",
  "DiscountTotal": 2.1
}

application/xml, text/xml

Sample:

<ControlCheckResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Integration.External">
  <DiscountTotal>2.1</DiscountTotal>
  <Result>Success</Result>
  <ResultMessage>sample string 1</ResultMessage>
</ControlCheckResult>