H2OAPIv20
Click here for a complete list of operations.
Inventory_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/Inventory_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> <Inventory_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> <Inventory> <ID>int</ID> <CustomerID>int</CustomerID> <Identifier>string</Identifier> <IdentifierLabel>string</IdentifierLabel> <InventoryTypeID>int</InventoryTypeID> <InventoryType>General or Telephone_Number or IP_Address or Mobile_Device or SIM_Card</InventoryType> <InventoryDescription>string</InventoryDescription> <Status>AVAILABLE or UNAVAILABLE or ASSIGNED</Status> <AssignedDate>dateTime</AssignedDate> <UnavailableReasonID>int</UnavailableReasonID> <UnavailableReasonDescription>string</UnavailableReasonDescription> <Note>string</Note> <Fields> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> </Fields> <Wireless> <MSID>string</MSID> <MSL>string</MSL> <MDN>string</MDN> </Wireless> </Inventory> </Request> </Inventory_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> <Inventory_CreateResponse xmlns="http://api.myh2o.com/v20"> <Inventory_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> <Inventory> <ID>int</ID> <CustomerID>int</CustomerID> <Identifier>string</Identifier> <IdentifierLabel>string</IdentifierLabel> <InventoryTypeID>int</InventoryTypeID> <InventoryType>General or Telephone_Number or IP_Address or Mobile_Device or SIM_Card</InventoryType> <InventoryDescription>string</InventoryDescription> <Status>AVAILABLE or UNAVAILABLE or ASSIGNED</Status> <AssignedDate>dateTime</AssignedDate> <UnavailableReasonID>int</UnavailableReasonID> <UnavailableReasonDescription>string</UnavailableReasonDescription> <Note>string</Note> <Fields> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> </Fields> <Wireless> <MSID>string</MSID> <MSL>string</MSL> <MDN>string</MDN> </Wireless> </Inventory> </Request> </Debug> <InventoryItemID>int</InventoryItemID> </Inventory_CreateResult> </Inventory_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> <Inventory_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> <Inventory> <ID>int</ID> <CustomerID>int</CustomerID> <Identifier>string</Identifier> <IdentifierLabel>string</IdentifierLabel> <InventoryTypeID>int</InventoryTypeID> <InventoryType>General or Telephone_Number or IP_Address or Mobile_Device or SIM_Card</InventoryType> <InventoryDescription>string</InventoryDescription> <Status>AVAILABLE or UNAVAILABLE or ASSIGNED</Status> <AssignedDate>dateTime</AssignedDate> <UnavailableReasonID>int</UnavailableReasonID> <UnavailableReasonDescription>string</UnavailableReasonDescription> <Note>string</Note> <Fields> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> </Fields> <Wireless> <MSID>string</MSID> <MSL>string</MSL> <MDN>string</MDN> </Wireless> </Inventory> </Request> </Inventory_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> <Inventory_CreateResponse xmlns="http://api.myh2o.com/v20"> <Inventory_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> <Inventory> <ID>int</ID> <CustomerID>int</CustomerID> <Identifier>string</Identifier> <IdentifierLabel>string</IdentifierLabel> <InventoryTypeID>int</InventoryTypeID> <InventoryType>General or Telephone_Number or IP_Address or Mobile_Device or SIM_Card</InventoryType> <InventoryDescription>string</InventoryDescription> <Status>AVAILABLE or UNAVAILABLE or ASSIGNED</Status> <AssignedDate>dateTime</AssignedDate> <UnavailableReasonID>int</UnavailableReasonID> <UnavailableReasonDescription>string</UnavailableReasonDescription> <Note>string</Note> <Fields> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> <Field> <FieldID>int</FieldID> <Label>string</Label> <Value>string</Value> </Field> </Fields> <Wireless> <MSID>string</MSID> <MSL>string</MSL> <MDN>string</MDN> </Wireless> </Inventory> </Request> </Debug> <InventoryItemID>int</InventoryItemID> </Inventory_CreateResult> </Inventory_CreateResponse> </soap12:Body> </soap12:Envelope>