Reference for https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetSaleAttribute/?id={ID}
Url: https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetSaleAttribute/?id={ID}
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:
<SaleAttribute xmlns="http://www.iVend.com/IIntegrationService/2010/12"> <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> <Name>String content</Name> <Sequence>2147483647</Sequence> <Required>true</Required> <IsActive>true</IsActive> <CaptureType>BeginingOfSale</CaptureType> <DefaultValue>String content</DefaultValue> <ValidationType>None</ValidationType> <ValidValueItems> <AttributeValidValue> <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> <Id>String content</Id> <Description>String content</Description> <Type>Sale</Type> <ValidValueKey>String content</ValidValueKey> </AttributeValidValue> <AttributeValidValue> <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> <Id>String content</Id> <Description>String content</Description> <Type>Sale</Type> <ValidValueKey>String content</ValidValueKey> </AttributeValidValue> </ValidValueItems> <Sale>true</Sale> <SaleRefund>true</SaleRefund> <SaleExchange>true</SaleExchange> <SpecialOrder>true</SpecialOrder> <Layaway>true</Layaway> <Quotation>true</Quotation> <GiftCertificate>true</GiftCertificate> <CouponIssue>true</CouponIssue> <AdvancePayment>true</AdvancePayment> <RegExPattern>String content</RegExPattern> <SaleAttributeKey>String content</SaleAttributeKey> <Delivery>true</Delivery> </SaleAttribute>
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", "Name":"String content", "Sequence":2147483647, "Required":true, "IsActive":true, "CaptureType":0, "DefaultValue":"String content", "ValidationType":0, "ValidValueItems":[{ "Message":"String content", "GenerateIntegrationEvent":true, "EnterpriseName":"String content", "UserFieldsList":[{ "FieldName":"String content", "FieldValue":"String content", "FieldType":0 }], "Key":"String content", "Id":"String content", "Description":"String content", "Type":0, "ValidValueKey":"String content" }], "Sale":true, "SaleRefund":true, "SaleExchange":true, "SpecialOrder":true, "Layaway":true, "Quotation":true, "GiftCertificate":true, "CouponIssue":true, "AdvancePayment":true, "RegExPattern":"String content", "SaleAttributeKey":"String content", "Delivery":true }
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.SubSystem.Core" /> <xs:import namespace="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" /> <xs:complexType name="SaleAttribute"> <xs:complexContent mixed="false"> <xs:extension base="tns:BaseWrapper"> <xs:sequence> <xs:element name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Sequence" type="xs:int" /> <xs:element minOccurs="0" name="Required" type="xs:boolean" /> <xs:element minOccurs="0" name="IsActive" type="xs:boolean" /> <xs:element minOccurs="0" name="CaptureType" xmlns:q1="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" type="q1:SaleAttributeCaptureType" /> <xs:element minOccurs="0" name="DefaultValue" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ValidationType" xmlns:q2="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" type="q2:SaleAttributeValidationType" /> <xs:element minOccurs="0" name="ValidValueItems" nillable="true" type="tns:ArrayOfAttributeValidValue" /> <xs:element minOccurs="0" name="Sale" type="xs:boolean" /> <xs:element minOccurs="0" name="SaleRefund" type="xs:boolean" /> <xs:element minOccurs="0" name="SaleExchange" type="xs:boolean" /> <xs:element minOccurs="0" name="SpecialOrder" type="xs:boolean" /> <xs:element minOccurs="0" name="Layaway" type="xs:boolean" /> <xs:element minOccurs="0" name="Quotation" type="xs:boolean" /> <xs:element minOccurs="0" name="GiftCertificate" type="xs:boolean" /> <xs:element minOccurs="0" name="CouponIssue" type="xs:boolean" /> <xs:element minOccurs="0" name="AdvancePayment" type="xs:boolean" /> <xs:element minOccurs="0" name="RegExPattern" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SaleAttributeKey" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Delivery" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="SaleAttribute" nillable="true" type="tns:SaleAttribute" /> <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:q3="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" type="q3:UserDefinedFieldDataType" /> </xs:sequence> </xs:complexType> <xs:element name="UserFields" nillable="true" type="tns:UserFields" /> <xs:complexType name="ArrayOfAttributeValidValue"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="AttributeValidValue" nillable="true" type="tns:AttributeValidValue" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfAttributeValidValue" nillable="true" type="tns:ArrayOfAttributeValidValue" /> <xs:complexType name="AttributeValidValue"> <xs:complexContent mixed="false"> <xs:extension base="tns:BaseWrapper"> <xs:sequence> <xs:element name="Id" nillable="true" type="xs:string" /> <xs:element name="Description" nillable="true" type="xs:string" /> <xs:element name="Type" xmlns:q4="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" type="q4:AttributeType" /> <xs:element minOccurs="0" name="ValidValueKey" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="AttributeValidValue" nillable="true" type="tns:AttributeValidValue" /> </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>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:simpleType name="SaleAttributeCaptureType"> <xs:restriction base="xs:string"> <xs:enumeration value="BeginingOfSale" /> <xs:enumeration value="EndOfSale" /> </xs:restriction> </xs:simpleType> <xs:element name="SaleAttributeCaptureType" nillable="true" type="tns:SaleAttributeCaptureType" /> <xs:simpleType name="SaleAttributeValidationType"> <xs:restriction base="xs:string"> <xs:enumeration value="None" /> <xs:enumeration value="Table" /> <xs:enumeration value="ValidValues" /> <xs:enumeration value="Customer" /> <xs:enumeration value="Product" /> </xs:restriction> </xs:simpleType> <xs:element name="SaleAttributeValidationType" nillable="true" type="tns:SaleAttributeValidationType" /> <xs:simpleType name="AttributeType"> <xs:restriction base="xs:string"> <xs:enumeration value="Sale"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="TransactionItem"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="PaymentType"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="AttributeType" nillable="true" type="tns:AttributeType" /> </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>