POST GetCustomer

Request Information

URI Parameters

None.

Body Parameters

GetCustomerRequest
NameDescriptionTypeAdditional information
Cs

ClientSecurity

None.

PhoneOrQrCode

string

None.

GetGifts

boolean

None.

ForUseBonus

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Cs": {
    "UserName": "sample string 1",
    "Pass": "sample string 2",
    "CompanyKey": "sample string 3"
  },
  "PhoneOrQrCode": "sample string 1",
  "GetGifts": true,
  "ForUseBonus": true
}

application/xml, text/xml

Sample:
<GetCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Integration.External">
  <Cs>
    <CompanyKey>sample string 3</CompanyKey>
    <Pass>sample string 2</Pass>
    <UserName>sample string 1</UserName>
  </Cs>
  <ForUseBonus>true</ForUseBonus>
  <GetGifts>true</GetGifts>
  <PhoneOrQrCode>sample string 1</PhoneOrQrCode>
</GetCustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetCustomerResult
NameDescriptionTypeAdditional information
Result

ServiceResult

None.

ResultMessage

string

None.

Customer

CustomerDto

None.

Gifts

Collection of GiftDto

None.

Puanibols

Collection of PuanibolDto

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": 0,
  "ResultMessage": "sample string 1",
  "Customer": {
    "Name": "sample string 1",
    "Surname": "sample string 2",
    "PhoneNumber": "sample string 3",
    "Sex": "sample string 4",
    "Birthday": {
      "Year": 1,
      "Month": 2,
      "Day": 3,
      "Hour": 4,
      "Minute": 5,
      "Second": 6,
      "Value": "0001-02-03T04:05:06",
      "NullableValue": "0001-02-03T04:05:06"
    },
    "Guid": "sample string 5",
    "Bonus": 6.1,
    "Tag": "sample string 7"
  },
  "Gifts": [
    {
      "Guid": "sample string 1",
      "CampaignName": "sample string 2",
      "CampaignDescription": "sample string 3",
      "Type": 0,
      "CardObjectType": 1,
      "CardObjectNo": "sample string 4",
      "GiftCardObjectType": 1,
      "GiftCardObjectNo": "sample string 5",
      "GiftObjectType": 1,
      "GiftDescription": "sample string 6",
      "DiscountType": 1,
      "DiscountValue": 7.1,
      "DiscountMinimumCheckTotal": 8.1,
      "BonusType": 1,
      "BonusValue": 9.1,
      "BonusMinimumCheckTotal": 10.1,
      "ItemNo": 11,
      "ItemGroupNo": 12,
      "FrameNo": 13,
      "RelationalConditionObjectType": 1,
      "RelationalConditionObjectNo": 14,
      "RelationalGiftObjectType": 1,
      "RelationalGiftObjectNo": 15,
      "RelationalDiscountPercentValue": 16.1
    },
    {
      "Guid": "sample string 1",
      "CampaignName": "sample string 2",
      "CampaignDescription": "sample string 3",
      "Type": 0,
      "CardObjectType": 1,
      "CardObjectNo": "sample string 4",
      "GiftCardObjectType": 1,
      "GiftCardObjectNo": "sample string 5",
      "GiftObjectType": 1,
      "GiftDescription": "sample string 6",
      "DiscountType": 1,
      "DiscountValue": 7.1,
      "DiscountMinimumCheckTotal": 8.1,
      "BonusType": 1,
      "BonusValue": 9.1,
      "BonusMinimumCheckTotal": 10.1,
      "ItemNo": 11,
      "ItemGroupNo": 12,
      "FrameNo": 13,
      "RelationalConditionObjectType": 1,
      "RelationalConditionObjectNo": 14,
      "RelationalGiftObjectType": 1,
      "RelationalGiftObjectNo": 15,
      "RelationalDiscountPercentValue": 16.1
    }
  ],
  "Puanibols": [
    {
      "CampaignName": "sample string 1",
      "CampaignDescription": "sample string 2",
      "Items": "sample string 3",
      "Frames": "sample string 4",
      "Groups": "sample string 5",
      "Value": 6.1,
      "PercentOrTotal": 1,
      "MaxUsePerDay": 7
    },
    {
      "CampaignName": "sample string 1",
      "CampaignDescription": "sample string 2",
      "Items": "sample string 3",
      "Frames": "sample string 4",
      "Groups": "sample string 5",
      "Value": 6.1,
      "PercentOrTotal": 1,
      "MaxUsePerDay": 7
    }
  ]
}

application/xml, text/xml

Sample:
<GetCustomerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Integration.External">
  <Customer>
    <Birthday xmlns:d3p1="http://schemas.datacontract.org/2004/07/Loyalty.Dto.Helpers">
      <d3p1:Day>3</d3p1:Day>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Year>1</d3p1:Year>
    </Birthday>
    <Bonus>6.1</Bonus>
    <Guid>sample string 5</Guid>
    <Name>sample string 1</Name>
    <PhoneNumber>sample string 3</PhoneNumber>
    <Sex>sample string 4</Sex>
    <Surname>sample string 2</Surname>
    <Tag>sample string 7</Tag>
  </Customer>
  <Gifts>
    <GiftDto>
      <BonusMinimumCheckTotal>10.1</BonusMinimumCheckTotal>
      <BonusType>Percent</BonusType>
      <BonusValue>9.1</BonusValue>
      <CampaignDescription>sample string 3</CampaignDescription>
      <CampaignName>sample string 2</CampaignName>
      <CardObjectNo>sample string 4</CardObjectNo>
      <CardObjectType>Item</CardObjectType>
      <DiscountMinimumCheckTotal>8.1</DiscountMinimumCheckTotal>
      <DiscountType>Percent</DiscountType>
      <DiscountValue>7.1</DiscountValue>
      <FrameNo>13</FrameNo>
      <GiftCardObjectNo>sample string 5</GiftCardObjectNo>
      <GiftCardObjectType>Item</GiftCardObjectType>
      <GiftDescription>sample string 6</GiftDescription>
      <GiftObjectType>Item</GiftObjectType>
      <Guid>sample string 1</Guid>
      <ItemGroupNo>12</ItemGroupNo>
      <ItemNo>11</ItemNo>
      <RelationalConditionObjectNo>14</RelationalConditionObjectNo>
      <RelationalConditionObjectType>Item</RelationalConditionObjectType>
      <RelationalDiscountPercentValue>16.1</RelationalDiscountPercentValue>
      <RelationalGiftObjectNo>15</RelationalGiftObjectNo>
      <RelationalGiftObjectType>Item</RelationalGiftObjectType>
      <Type>Gift</Type>
    </GiftDto>
    <GiftDto>
      <BonusMinimumCheckTotal>10.1</BonusMinimumCheckTotal>
      <BonusType>Percent</BonusType>
      <BonusValue>9.1</BonusValue>
      <CampaignDescription>sample string 3</CampaignDescription>
      <CampaignName>sample string 2</CampaignName>
      <CardObjectNo>sample string 4</CardObjectNo>
      <CardObjectType>Item</CardObjectType>
      <DiscountMinimumCheckTotal>8.1</DiscountMinimumCheckTotal>
      <DiscountType>Percent</DiscountType>
      <DiscountValue>7.1</DiscountValue>
      <FrameNo>13</FrameNo>
      <GiftCardObjectNo>sample string 5</GiftCardObjectNo>
      <GiftCardObjectType>Item</GiftCardObjectType>
      <GiftDescription>sample string 6</GiftDescription>
      <GiftObjectType>Item</GiftObjectType>
      <Guid>sample string 1</Guid>
      <ItemGroupNo>12</ItemGroupNo>
      <ItemNo>11</ItemNo>
      <RelationalConditionObjectNo>14</RelationalConditionObjectNo>
      <RelationalConditionObjectType>Item</RelationalConditionObjectType>
      <RelationalDiscountPercentValue>16.1</RelationalDiscountPercentValue>
      <RelationalGiftObjectNo>15</RelationalGiftObjectNo>
      <RelationalGiftObjectType>Item</RelationalGiftObjectType>
      <Type>Gift</Type>
    </GiftDto>
  </Gifts>
  <Puanibols>
    <PuanibolDto>
      <CampaignDescription>sample string 2</CampaignDescription>
      <CampaignName>sample string 1</CampaignName>
      <Frames>sample string 4</Frames>
      <Groups>sample string 5</Groups>
      <Items>sample string 3</Items>
      <MaxUsePerDay>7</MaxUsePerDay>
      <PercentOrTotal>Percent</PercentOrTotal>
      <Value>6.1</Value>
    </PuanibolDto>
    <PuanibolDto>
      <CampaignDescription>sample string 2</CampaignDescription>
      <CampaignName>sample string 1</CampaignName>
      <Frames>sample string 4</Frames>
      <Groups>sample string 5</Groups>
      <Items>sample string 3</Items>
      <MaxUsePerDay>7</MaxUsePerDay>
      <PercentOrTotal>Percent</PercentOrTotal>
      <Value>6.1</Value>
    </PuanibolDto>
  </Puanibols>
  <Result>Success</Result>
  <ResultMessage>sample string 1</ResultMessage>
</GetCustomerResult>