Reference for https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetPointsSummaryForPortalIntegration/?LoyaltyConfigKey={LOYALTYCONFIGKEY}
Url: https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetPointsSummaryForPortalIntegration/?LoyaltyConfigKey={LOYALTYCONFIGKEY}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<ArrayOfCustomerSummery xmlns="http://www.iVend.com/IIntegrationService/2010/12">
<CustomerSummery>
<Message>String content</Message>
<GenerateIntegrationEvent>true</GenerateIntegrationEvent>
<EnterpriseName>String content</EnterpriseName>
<UserFieldsList>
<UserFields>
<FieldName>String content</FieldName>
<FieldValue>String content</FieldValue>
<FieldType>String</FieldType>
</UserFields>
<UserFields>
<FieldName>String content</FieldName>
<FieldValue>String content</FieldValue>
<FieldType>String</FieldType>
</UserFields>
</UserFieldsList>
<Key>String content</Key>
<AvailablePoints>2147483647</AvailablePoints>
<AvailableCurrency>12678967.543233</AvailableCurrency>
<RedeemedPoints>9223372036854775807</RedeemedPoints>
<RedeemedCurrency>12678967.543233</RedeemedCurrency>
<AwardedPoints>9223372036854775807</AwardedPoints>
<AwardedCurrency>12678967.543233</AwardedCurrency>
<ExpiredPoints>2147483647</ExpiredPoints>
<ExpiredCurrency>12678967.543233</ExpiredCurrency>
<CurrentSlab>String content</CurrentSlab>
<GroupName>String content</GroupName>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Email>String content</Email>
<LoyaltyId>String content</LoyaltyId>
<PhoneNumber>String content</PhoneNumber>
<MobilePhone>String content</MobilePhone>
<Gender>String content</Gender>
<BirthDate>1999-05-31T11:20:00</BirthDate>
<AnniversaryDate>1999-05-31T11:20:00</AnniversaryDate>
<Address1>String content</Address1>
<Address2>String content</Address2>
<City>String content</City>
<State>String content</State>
<ZipCode>String content</ZipCode>
<Country>String content</Country>
<CountryKey>String content</CountryKey>
<StateKey>String content</StateKey>
<CustomerKey>String content</CustomerKey>
<PointsSummaryKey>String content</PointsSummaryKey>
<AvailableRedeemableCurrency>12678967.543233</AvailableRedeemableCurrency>
</CustomerSummery>
<CustomerSummery>
<Message>String content</Message>
<GenerateIntegrationEvent>true</GenerateIntegrationEvent>
<EnterpriseName>String content</EnterpriseName>
<UserFieldsList>
<UserFields>
<FieldName>String content</FieldName>
<FieldValue>String content</FieldValue>
<FieldType>String</FieldType>
</UserFields>
<UserFields>
<FieldName>String content</FieldName>
<FieldValue>String content</FieldValue>
<FieldType>String</FieldType>
</UserFields>
</UserFieldsList>
<Key>String content</Key>
<AvailablePoints>2147483647</AvailablePoints>
<AvailableCurrency>12678967.543233</AvailableCurrency>
<RedeemedPoints>9223372036854775807</RedeemedPoints>
<RedeemedCurrency>12678967.543233</RedeemedCurrency>
<AwardedPoints>9223372036854775807</AwardedPoints>
<AwardedCurrency>12678967.543233</AwardedCurrency>
<ExpiredPoints>2147483647</ExpiredPoints>
<ExpiredCurrency>12678967.543233</ExpiredCurrency>
<CurrentSlab>String content</CurrentSlab>
<GroupName>String content</GroupName>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Email>String content</Email>
<LoyaltyId>String content</LoyaltyId>
<PhoneNumber>String content</PhoneNumber>
<MobilePhone>String content</MobilePhone>
<Gender>String content</Gender>
<BirthDate>1999-05-31T11:20:00</BirthDate>
<AnniversaryDate>1999-05-31T11:20:00</AnniversaryDate>
<Address1>String content</Address1>
<Address2>String content</Address2>
<City>String content</City>
<State>String content</State>
<ZipCode>String content</ZipCode>
<Country>String content</Country>
<CountryKey>String content</CountryKey>
<StateKey>String content</StateKey>
<CustomerKey>String content</CustomerKey>
<PointsSummaryKey>String content</PointsSummaryKey>
<AvailableRedeemableCurrency>12678967.543233</AvailableRedeemableCurrency>
</CustomerSummery>
</ArrayOfCustomerSummery>
The following is an example response Json body:
[{
"Message":"String content",
"GenerateIntegrationEvent":true,
"EnterpriseName":"String content",
"UserFieldsList":[{
"FieldName":"String content",
"FieldValue":"String content",
"FieldType":0
}],
"Key":"String content",
"AvailablePoints":2147483647,
"AvailableCurrency":12678967.543233,
"RedeemedPoints":9223372036854775807,
"RedeemedCurrency":12678967.543233,
"AwardedPoints":9223372036854775807,
"AwardedCurrency":12678967.543233,
"ExpiredPoints":2147483647,
"ExpiredCurrency":12678967.543233,
"CurrentSlab":"String content",
"GroupName":"String content",
"FirstName":"String content",
"LastName":"String content",
"Email":"String content",
"LoyaltyId":"String content",
"PhoneNumber":"String content",
"MobilePhone":"String content",
"Gender":"String content",
"BirthDate":"\/Date(928149600000+0000)\/",
"AnniversaryDate":"\/Date(928149600000+0000)\/",
"Address1":"String content",
"Address2":"String content",
"City":"String content",
"State":"String content",
"ZipCode":"String content",
"Country":"String content",
"CountryKey":"String content",
"StateKey":"String content",
"CustomerKey":"String content",
"PointsSummaryKey":"String content",
"AvailableRedeemableCurrency":12678967.543233
}]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://www.iVend.com/IIntegrationService/2010/12" elementFormDefault="qualified" targetNamespace="http://www.iVend.com/IIntegrationService/2010/12" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" />
<xs:complexType name="ArrayOfCustomerSummery">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomerSummery" nillable="true" type="tns:CustomerSummery" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomerSummery" nillable="true" type="tns:ArrayOfCustomerSummery" />
<xs:complexType name="CustomerSummery">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseWrapper">
<xs:sequence>
<xs:element minOccurs="0" name="AvailablePoints" type="xs:int" />
<xs:element minOccurs="0" name="AvailableCurrency" type="xs:decimal" />
<xs:element minOccurs="0" name="RedeemedPoints" type="xs:long" />
<xs:element minOccurs="0" name="RedeemedCurrency" type="xs:decimal" />
<xs:element minOccurs="0" name="AwardedPoints" type="xs:long" />
<xs:element minOccurs="0" name="AwardedCurrency" type="xs:decimal" />
<xs:element minOccurs="0" name="ExpiredPoints" type="xs:int" />
<xs:element minOccurs="0" name="ExpiredCurrency" type="xs:decimal" />
<xs:element minOccurs="0" name="CurrentSlab" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="GroupName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LoyaltyId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PhoneNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="MobilePhone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Gender" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="BirthDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="AnniversaryDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Address1" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Address2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ZipCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Country" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CountryKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StateKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomerKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PointsSummaryKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="AvailableRedeemableCurrency" type="xs:decimal" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CustomerSummery" nillable="true" type="tns:CustomerSummery" />
<xs:complexType name="BaseWrapper">
<xs:sequence>
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="GenerateIntegrationEvent" type="xs:boolean" />
<xs:element minOccurs="0" name="EnterpriseName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="UserFieldsList" nillable="true" type="tns:ArrayOfUserFields" />
<xs:element minOccurs="0" name="Key" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="BaseWrapper" nillable="true" type="tns:BaseWrapper" />
<xs:complexType name="ArrayOfUserFields">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="UserFields" nillable="true" type="tns:UserFields" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfUserFields" nillable="true" type="tns:ArrayOfUserFields" />
<xs:complexType name="UserFields">
<xs:sequence>
<xs:element name="FieldName" nillable="true" type="xs:string" />
<xs:element name="FieldValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FieldType" xmlns:q1="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" type="q1:UserDefinedFieldDataType" />
</xs:sequence>
</xs:complexType>
<xs:element name="UserFields" nillable="true" type="tns:UserFields" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:simpleType name="UserDefinedFieldDataType">
<xs:restriction base="xs:string">
<xs:enumeration value="String">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Int32">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Currency">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Decimal">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="DateTime">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ValidValues">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Int64">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Boolean">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Image">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="UserDefinedFieldDataType" nillable="true" type="tns:UserDefinedFieldDataType" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>