PublicAPIService
Click here for a complete list of operations.
AddModel2
Add a Model (uses the ModelData object)
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 /PIP/publicAPIService.asmx HTTP/1.1 Host: einfo.gfidigital.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/AddModel2" <?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> <AddModel2 xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <Model> <Model> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Model> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <Make> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Make> <Category> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Category> <Active> <Value>boolean</Value> <Valid>boolean</Valid> </Active> <Host> <Value>boolean</Value> <Valid>boolean</Valid> </Host> <Accessory> <Value>boolean</Value> <Valid>boolean</Valid> </Accessory> <Metered> <Value>boolean</Value> <Valid>boolean</Valid> </Metered> <MeterInstructions> <Value>string</Value> <Valid>boolean</Valid> </MeterInstructions> <IntroductionDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </IntroductionDate> <MfgDiscontinuedDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </MfgDiscontinuedDate> <ServiceDiscontinuedDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </ServiceDiscontinuedDate> <RequireMeteronServiceCalls> <Value>boolean</Value> <Valid>boolean</Valid> </RequireMeteronServiceCalls> </Model> </AddModel2> </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> <AddModel2Response xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <AddModel2Result> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </AddModel2Result> </AddModel2Response> </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 /PIP/publicAPIService.asmx HTTP/1.1 Host: einfo.gfidigital.com 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> <AddModel2 xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <Model> <Model> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Model> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <Make> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Make> <Category> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Category> <Active> <Value>boolean</Value> <Valid>boolean</Valid> </Active> <Host> <Value>boolean</Value> <Valid>boolean</Valid> </Host> <Accessory> <Value>boolean</Value> <Valid>boolean</Valid> </Accessory> <Metered> <Value>boolean</Value> <Valid>boolean</Valid> </Metered> <MeterInstructions> <Value>string</Value> <Valid>boolean</Valid> </MeterInstructions> <IntroductionDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </IntroductionDate> <MfgDiscontinuedDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </MfgDiscontinuedDate> <ServiceDiscontinuedDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </ServiceDiscontinuedDate> <RequireMeteronServiceCalls> <Value>boolean</Value> <Valid>boolean</Valid> </RequireMeteronServiceCalls> </Model> </AddModel2> </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> <AddModel2Response xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <AddModel2Result> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </AddModel2Result> </AddModel2Response> </soap12:Body> </soap12:Envelope>