Child pages
  • DOTS GeoPhone Plus - REST
Skip to end of metadata
Go to start of metadata

Introduction

DOTS GeoPhone Plus REST API is a publicly available service which provides REST style endpoints to the DOTS GeoPhone Plus service. All of the latest methods available in the current service are available through the REST API.

Web Service Structure

Request Methods

DOTS GeoPhone Plus REST API accepts HTTP GET and HTTP POST methods.

Request and Response Formats

DOTS GeoPhone Plus REST API is capable of accepting JSON or XML input. As well, DOTS GeoPhone Plus REST API provides XML or JSON output which can be specified in the request.

Host Path URL

http://trial.serviceobjects.com/rest/gppl/api.svc

Test Page

http://trial.serviceobjects.com/rest/gppl/

Endpoints available at this service.

http://trial.serviceobjects.com/rest/gppl/api.svc/help

Web Service Operations

Below is a list of the current support operations available through the DOTS GeoPhone Plus - Rest API.

Any parameter that is empty or null should be replaced with an empty space character and the last parameter replaced with any string when building a GET URL.

GetPhoneInfo_V2

HTTP GET: XML Response

Url:  http://trial.serviceobjects.com/rest/GPPL/api.svc/PhoneInfo/V2/{PHONENUMBER}/{TESTTYPE}/{LICENSEKEY}?format=xml

<PhoneInfoResponse xmlns="http://www.serviceobjects.com">
  <Error>
    <Type>String content</Type>
    <TypeCode>String content</TypeCode>
    <Desc>String content</Desc>
    <DescCode>String content</DescCode>
  </Error>
  <PhoneInfo>
    <PhoneNumberIn>String content</PhoneNumberIn>
    <PhoneNumberClean>String content</PhoneNumberClean>
    <Providers>
      <ProviderInfo>
        <Name>String content</Name>
        <City>String content</City>
        <State>String content</State>
        <LineType>String content</LineType>
        <Latitude>String content</Latitude>
        <Longitude>String content</Longitude>
      </ProviderInfo>
      <ProviderInfo>
        <Name>String content</Name>
        <City>String content</City>
        <State>String content</State>
        <LineType>String content</LineType>
        <Latitude>String content</Latitude>
        <Longitude>String content</Longitude>
      </ProviderInfo>
    </Providers>
    <Contacts>
      <ContactInfo>
        <Name>String content</Name>
        <Address>String content</Address>
        <City>String content</City>
        <State>String content</State>
        <Zip>String content</Zip>
        <Type>String content</Type>
        <Quality>String content</Quality>
      </ContactInfo>
      <ContactInfo>
        <Name>String content</Name>
        <Address>String content</Address>
        <City>String content</City>
        <State>String content</State>
        <Zip>String content</Zip>
        <Type>String content</Type>
        <Quality>String content</Quality>
      </ContactInfo>
    </Contacts>
  </PhoneInfo>
  <TokensUsed>String content</TokensUsed>
  <IsConnected>String content</IsConnected>
  <RecommendConnectionCheck>String content</RecommendConnectionCheck>
  <DEBUG>String content</DEBUG>
</PhoneInfoResponse>

HTTP GET: JSON Response

Url:  http://trial.serviceobjects.com/rest/GPPL/api.svc/PhoneInfo/V2/{PHONENUMBER}/{TESTTYPE}/{LICENSEKEY}?format=json

{
	"Error":{
		"Type":"String content",
		"TypeCode":"String content",
		"Desc":"String content",
		"DescCode":"String content"
	},
	"PhoneInfo":{
		"PhoneNumberIn":"String content",
		"PhoneNumberClean":"String content",
		"Providers":[{
			"Name":"String content",
			"City":"String content",
			"State":"String content",
			"LineType":"String content",
			"Latitude":"String content",
			"Longitude":"String content"
		}],
		"Contacts":[{
			"Name":"String content",
			"Address":"String content",
			"City":"String content",
			"State":"String content",
			"Zip":"String content",
			"Type":"String content",
			"Quality":"String content"
		}]
	},
	"TokensUsed":"String content",
	"IsConnected":"String content",
	"RecommendConnectionCheck":"String content",
	"DEBUG":"String content"
}

 

HTTP POST: JSON RESPONSE

Example JSON Request using Fiddler HTTP Debugging Proxy

User-Agent: Fiddler
Content-Type: application/json
Host: trial.serviceobjects.com
Content-Length: 83

{"PhoneNumber":"8059631700" ,  "TestType":"full" ,"LicenseKey":"YOUR-LICENSE-KEY" }

JSON RESPONSE

{
	"Error":{
		"Type":"String content",
		"TypeCode":"String content",
		"Desc":"String content",
		"DescCode":"String content"
	},
	"PhoneInfo":{
		"PhoneNumberIn":"String content",
		"PhoneNumberClean":"String content",
		"Providers":[{
			"Name":"String content",
			"City":"String content",
			"State":"String content",
			"LineType":"String content",
			"Latitude":"String content",
			"Longitude":"String content"
		}],
		"Contacts":[{
			"Name":"String content",
			"Address":"String content",
			"City":"String content",
			"State":"String content",
			"Zip":"String content",
			"Type":"String content",
			"Quality":"String content"
		}]
	},
	"TokensUsed":"String content",
	"IsConnected":"String content",
	"RecommendConnectionCheck":"String content",
	"DEBUG":"String content"
}

 

 

 

 

Service Reference

 

For more information about the DOTS GeoPhone Plus service please see our Developer Guide.

 

Conclusion

 

ServiceObjects is proud to offer you a free trial of DOTS GeoPhone Plus - REST API

Sign up today for a free trial at:
http://www.serviceobjects.com/products/phone

Other technical questions or concerns can be directed to support@serviceobjects.com.

If you are interested in purchasing DOTS GeoPhone Plus – US, please contact sales@serviceobjects.com 

We welcome your feedback! Please do not hesitate to let us know what you think of our web services, documentation, or customer support.
www.serviceobjects.com

 


  • No labels