H2OAPIv20
Click here for a complete list of operations.
Products_Create
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v20/default.asmx HTTP/1.1 Host: api.rev.io Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://api.myh2o.com/v20/Products_Create" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Products_Create xmlns="http://api.myh2o.com/v20"> <Request> <Credentials> <Username>string</Username> <Password>string</Password> <Client>string</Client> <ImpersonationKey>string</ImpersonationKey> </Credentials> <Session> <SessionKey>string</SessionKey> </Session> <Debug>boolean</Debug> <Product> <ID>int</ID> <Description>string</Description> <ProductTypeID>int</ProductTypeID> <CarrierID>int</CarrierID> <Code1>string</Code1> <Code2>string</Code2> <Rate>decimal</Rate> <FreeMonths>int</FreeMonths> <AutomaticExpiration>int</AutomaticExpiration> <BillingMonths>int</BillingMonths> <State>string</State> <BillInArrears>boolean</BillInArrears> <Prorate>boolean</Prorate> <ProrateOnDisconnect>boolean</ProrateOnDisconnect> <ProductCategoryID>int</ProductCategoryID> <OrderCompletionBilling>boolean</OrderCompletionBilling> <CreatesOrder>boolean</CreatesOrder> <Fields> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> </Fields> <ActiveFlag>boolean</ActiveFlag> <Cost>decimal</Cost> </Product> </Request> </Products_Create> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Products_CreateResponse xmlns="http://api.myh2o.com/v20"> <Products_CreateResult> <Header> <Success>boolean</Success> <Message>string</Message> <SessionKey>string</SessionKey> <Impersonated>boolean</Impersonated> <Error_Code>string</Error_Code> <Error_Description>string</Error_Description> </Header> <Debug> <Request> <Credentials> <Username>string</Username> <Password>string</Password> <Client>string</Client> <ImpersonationKey>string</ImpersonationKey> </Credentials> <Session> <SessionKey>string</SessionKey> </Session> <Debug>boolean</Debug> <Product> <ID>int</ID> <Description>string</Description> <ProductTypeID>int</ProductTypeID> <CarrierID>int</CarrierID> <Code1>string</Code1> <Code2>string</Code2> <Rate>decimal</Rate> <FreeMonths>int</FreeMonths> <AutomaticExpiration>int</AutomaticExpiration> <BillingMonths>int</BillingMonths> <State>string</State> <BillInArrears>boolean</BillInArrears> <Prorate>boolean</Prorate> <ProrateOnDisconnect>boolean</ProrateOnDisconnect> <ProductCategoryID>int</ProductCategoryID> <OrderCompletionBilling>boolean</OrderCompletionBilling> <CreatesOrder>boolean</CreatesOrder> <Fields> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> </Fields> <ActiveFlag>boolean</ActiveFlag> <Cost>decimal</Cost> </Product> </Request> </Debug> <ProductID>int</ProductID> </Products_CreateResult> </Products_CreateResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v20/default.asmx HTTP/1.1 Host: api.rev.io Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Products_Create xmlns="http://api.myh2o.com/v20"> <Request> <Credentials> <Username>string</Username> <Password>string</Password> <Client>string</Client> <ImpersonationKey>string</ImpersonationKey> </Credentials> <Session> <SessionKey>string</SessionKey> </Session> <Debug>boolean</Debug> <Product> <ID>int</ID> <Description>string</Description> <ProductTypeID>int</ProductTypeID> <CarrierID>int</CarrierID> <Code1>string</Code1> <Code2>string</Code2> <Rate>decimal</Rate> <FreeMonths>int</FreeMonths> <AutomaticExpiration>int</AutomaticExpiration> <BillingMonths>int</BillingMonths> <State>string</State> <BillInArrears>boolean</BillInArrears> <Prorate>boolean</Prorate> <ProrateOnDisconnect>boolean</ProrateOnDisconnect> <ProductCategoryID>int</ProductCategoryID> <OrderCompletionBilling>boolean</OrderCompletionBilling> <CreatesOrder>boolean</CreatesOrder> <Fields> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> </Fields> <ActiveFlag>boolean</ActiveFlag> <Cost>decimal</Cost> </Product> </Request> </Products_Create> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Products_CreateResponse xmlns="http://api.myh2o.com/v20"> <Products_CreateResult> <Header> <Success>boolean</Success> <Message>string</Message> <SessionKey>string</SessionKey> <Impersonated>boolean</Impersonated> <Error_Code>string</Error_Code> <Error_Description>string</Error_Description> </Header> <Debug> <Request> <Credentials> <Username>string</Username> <Password>string</Password> <Client>string</Client> <ImpersonationKey>string</ImpersonationKey> </Credentials> <Session> <SessionKey>string</SessionKey> </Session> <Debug>boolean</Debug> <Product> <ID>int</ID> <Description>string</Description> <ProductTypeID>int</ProductTypeID> <CarrierID>int</CarrierID> <Code1>string</Code1> <Code2>string</Code2> <Rate>decimal</Rate> <FreeMonths>int</FreeMonths> <AutomaticExpiration>int</AutomaticExpiration> <BillingMonths>int</BillingMonths> <State>string</State> <BillInArrears>boolean</BillInArrears> <Prorate>boolean</Prorate> <ProrateOnDisconnect>boolean</ProrateOnDisconnect> <ProductCategoryID>int</ProductCategoryID> <OrderCompletionBilling>boolean</OrderCompletionBilling> <CreatesOrder>boolean</CreatesOrder> <Fields> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> <CustomFieldItem> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </CustomFieldItem> </Fields> <ActiveFlag>boolean</ActiveFlag> <Cost>decimal</Cost> </Product> </Request> </Debug> <ProductID>int</ProductID> </Products_CreateResult> </Products_CreateResponse> </soap12:Body> </soap12:Envelope>