Reference for http://sample.exigo.com/csharp/VendorWebService.svc/rest/GetSubscriptions?vendor={VENDOR}&id={ID}
Url: http://sample.exigo.com/csharp/VendorWebService.svc/rest/GetSubscriptions?vendor={VENDOR}&id={ID}
HTTP Method: GET
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:
<GetSubscriptionsResponse xmlns="http://schemas.datacontract.org/2004/07/VendorWebService"> <Autoships> <AutoshipResponse> <AutoshipID>2147483647</AutoshipID> <Details> <AutoshipDetailResponse> <BVEach>12678967.543233</BVEach> <BVTotal>12678967.543233</BVTotal> <CVEach>12678967.543233</CVEach> <CVTotal>12678967.543233</CVTotal> <Description>String content</Description> <IsKitMember>true</IsKitMember> <ItemCode>String content</ItemCode> <KitParentItemCode>String content</KitParentItemCode> <PriceEach>12678967.543233</PriceEach> <PriceTotal>12678967.543233</PriceTotal> <Quantity>12678967.543233</Quantity> </AutoshipDetailResponse> <AutoshipDetailResponse> <BVEach>12678967.543233</BVEach> <BVTotal>12678967.543233</BVTotal> <CVEach>12678967.543233</CVEach> <CVTotal>12678967.543233</CVTotal> <Description>String content</Description> <IsKitMember>true</IsKitMember> <ItemCode>String content</ItemCode> <KitParentItemCode>String content</KitParentItemCode> <PriceEach>12678967.543233</PriceEach> <PriceTotal>12678967.543233</PriceTotal> <Quantity>12678967.543233</Quantity> </AutoshipDetailResponse> </Details> <Frequency>Weekly</Frequency> <LastRunDate>1999-05-31T11:20:00</LastRunDate> <NextRunDate>1999-05-31T11:20:00</NextRunDate> <StartDate>1999-05-31T11:20:00</StartDate> <StopDate>1999-05-31T11:20:00</StopDate> </AutoshipResponse> <AutoshipResponse> <AutoshipID>2147483647</AutoshipID> <Details> <AutoshipDetailResponse> <BVEach>12678967.543233</BVEach> <BVTotal>12678967.543233</BVTotal> <CVEach>12678967.543233</CVEach> <CVTotal>12678967.543233</CVTotal> <Description>String content</Description> <IsKitMember>true</IsKitMember> <ItemCode>String content</ItemCode> <KitParentItemCode>String content</KitParentItemCode> <PriceEach>12678967.543233</PriceEach> <PriceTotal>12678967.543233</PriceTotal> <Quantity>12678967.543233</Quantity> </AutoshipDetailResponse> <AutoshipDetailResponse> <BVEach>12678967.543233</BVEach> <BVTotal>12678967.543233</BVTotal> <CVEach>12678967.543233</CVEach> <CVTotal>12678967.543233</CVTotal> <Description>String content</Description> <IsKitMember>true</IsKitMember> <ItemCode>String content</ItemCode> <KitParentItemCode>String content</KitParentItemCode> <PriceEach>12678967.543233</PriceEach> <PriceTotal>12678967.543233</PriceTotal> <Quantity>12678967.543233</Quantity> </AutoshipDetailResponse> </Details> <Frequency>Weekly</Frequency> <LastRunDate>1999-05-31T11:20:00</LastRunDate> <NextRunDate>1999-05-31T11:20:00</NextRunDate> <StartDate>1999-05-31T11:20:00</StartDate> <StopDate>1999-05-31T11:20:00</StopDate> </AutoshipResponse> </Autoships> <Subscriptions> <SubscriptionResponse> <ExpirationDate>1999-05-31T11:20:00</ExpirationDate> <StartDate>1999-05-31T11:20:00</StartDate> <Status>NotFound</Status> <SubscriptionID>2147483647</SubscriptionID> </SubscriptionResponse> <SubscriptionResponse> <ExpirationDate>1999-05-31T11:20:00</ExpirationDate> <StartDate>1999-05-31T11:20:00</StartDate> <Status>NotFound</Status> <SubscriptionID>2147483647</SubscriptionID> </SubscriptionResponse> </Subscriptions> </GetSubscriptionsResponse>
The following is an example response Json body:
{ "Autoships":[{ "AutoshipID":2147483647, "Details":[{ "BVEach":12678967.543233, "BVTotal":12678967.543233, "CVEach":12678967.543233, "CVTotal":12678967.543233, "Description":"String content", "IsKitMember":true, "ItemCode":"String content", "KitParentItemCode":"String content", "PriceEach":12678967.543233, "PriceTotal":12678967.543233, "Quantity":12678967.543233 }], "Frequency":0, "LastRunDate":"\/Date(928167600000-0500)\/", "NextRunDate":"\/Date(928167600000-0500)\/", "StartDate":"\/Date(928167600000-0500)\/", "StopDate":"\/Date(928167600000-0500)\/" }], "Subscriptions":[{ "ExpirationDate":"\/Date(928167600000-0500)\/", "StartDate":"\/Date(928167600000-0500)\/", "Status":0, "SubscriptionID":2147483647 }] }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VendorWebService" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VendorWebService" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/ExigoWebService" /> <xs:complexType name="GetSubscriptionsResponse"> <xs:sequence> <xs:element minOccurs="0" name="Autoships" nillable="true" type="tns:ArrayOfAutoshipResponse" /> <xs:element minOccurs="0" name="Subscriptions" nillable="true" type="tns:ArrayOfSubscriptionResponse" /> </xs:sequence> </xs:complexType> <xs:element name="GetSubscriptionsResponse" nillable="true" type="tns:GetSubscriptionsResponse" /> <xs:complexType name="ArrayOfAutoshipResponse"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="AutoshipResponse" nillable="true" type="tns:AutoshipResponse" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfAutoshipResponse" nillable="true" type="tns:ArrayOfAutoshipResponse" /> <xs:complexType name="AutoshipResponse"> <xs:sequence> <xs:element minOccurs="0" name="AutoshipID" type="xs:int" /> <xs:element minOccurs="0" name="Details" nillable="true" type="tns:ArrayOfAutoshipDetailResponse" /> <xs:element minOccurs="0" name="Frequency" xmlns:q1="http://schemas.datacontract.org/2004/07/ExigoWebService" type="q1:FrequencyType" /> <xs:element minOccurs="0" name="LastRunDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="NextRunDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="StartDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="StopDate" type="xs:dateTime" /> </xs:sequence> </xs:complexType> <xs:element name="AutoshipResponse" nillable="true" type="tns:AutoshipResponse" /> <xs:complexType name="ArrayOfAutoshipDetailResponse"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="AutoshipDetailResponse" nillable="true" type="tns:AutoshipDetailResponse" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfAutoshipDetailResponse" nillable="true" type="tns:ArrayOfAutoshipDetailResponse" /> <xs:complexType name="AutoshipDetailResponse"> <xs:sequence> <xs:element minOccurs="0" name="BVEach" type="xs:decimal" /> <xs:element minOccurs="0" name="BVTotal" type="xs:decimal" /> <xs:element minOccurs="0" name="CVEach" type="xs:decimal" /> <xs:element minOccurs="0" name="CVTotal" type="xs:decimal" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsKitMember" type="xs:boolean" /> <xs:element minOccurs="0" name="ItemCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="KitParentItemCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PriceEach" type="xs:decimal" /> <xs:element minOccurs="0" name="PriceTotal" type="xs:decimal" /> <xs:element minOccurs="0" name="Quantity" type="xs:decimal" /> </xs:sequence> </xs:complexType> <xs:element name="AutoshipDetailResponse" nillable="true" type="tns:AutoshipDetailResponse" /> <xs:complexType name="ArrayOfSubscriptionResponse"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SubscriptionResponse" nillable="true" type="tns:SubscriptionResponse" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSubscriptionResponse" nillable="true" type="tns:ArrayOfSubscriptionResponse" /> <xs:complexType name="SubscriptionResponse"> <xs:sequence> <xs:element minOccurs="0" name="ExpirationDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="StartDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="Status" type="tns:SubscriptionStatusType" /> <xs:element minOccurs="0" name="SubscriptionID" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="SubscriptionResponse" nillable="true" type="tns:SubscriptionResponse" /> <xs:simpleType name="SubscriptionStatusType"> <xs:restriction base="xs:string"> <xs:enumeration value="NotFound" /> <xs:enumeration value="Active" /> <xs:enumeration value="Expired" /> <xs:enumeration value="Cancelled" /> </xs:restriction> </xs:simpleType> <xs:element name="SubscriptionStatusType" nillable="true" type="tns:SubscriptionStatusType" /> </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/ExigoWebService" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/ExigoWebService" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="FrequencyType"> <xs:restriction base="xs:string"> <xs:enumeration value="Weekly" /> <xs:enumeration value="BiWeekly" /> <xs:enumeration value="Monthly" /> <xs:enumeration value="BiMonthly" /> <xs:enumeration value="Quarterly" /> <xs:enumeration value="SemiYearly" /> <xs:enumeration value="Yearly" /> <xs:enumeration value="EveryFourWeeks" /> </xs:restriction> </xs:simpleType> <xs:element name="FrequencyType" nillable="true" type="tns:FrequencyType" /> </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>