Phonecheck REST Resources

By Adam Rhoads
2 min

A REST resource is an abstraction of a piece of information or an action, such as a single data record, a collection of records, or a query. Each resource in REST API is identified by a named Uniform Resource Identifier (URL) and is accessed using standard HTTP methods (HEAD, GET, POST, PATCH, DELETE). REST API is based on the usage of resources, their URL's, and the links between them.

You use a resource to interact with Phonecheck system. For example, you can:

Retrieve device information related to:

  • Manufacturer

  • Model

  • Storage

  • Battery

  • Verify device by checking ESN

  • Verify device by checking iCloud / Find My iPhone Status

It is mandatory to provide Rest Resource required information to retrieve valid and expected outcome.

Important characteristics of the Phonecheck.com REST API resources and architecture:

Stateless

  • Each request from client to server must contain all the information necessary to understand the request, and not use any stored context on the server. However, the representations of the resources are interconnected using URLs, which allow the client to progress between states.

Uniform Interface

  • All resources are accessed with a generic interface over HTTPS.

Named Resources

Authentication

  • The phonecheck.com provides API authentication key for specific account. By Providing API Key details we mark user as authorized and eligible to access our REST Resources.

Support for JSON and Text / HTML

  • JSON is the default output in Phonecheck Rest API along with plain/text sample error responses depending upon particular API characteristics.

  • The JavaScript Object Notation (JSON) format is supported with UTF-8. Date-time information is in ISO8601 format.

  • Text/Html serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and Text/Html responses are provided in UTF-8.

Friendly URL’s

  • Why make two API calls when you can make just one? A friendly URL provides an intuitive way to construct REST API requests and minimizes the number of round-trips between your app and Phonecheck. Friendly URL’s are available in API version 3.0 and later.

  • Accessing the ESN responses for different carriers without a friendly URL involves requesting the contact record using the SObject Rows resource. Then you check specific carrier record with another call to SObject Rows. Using a friendly URL, you can check the ESN response within the same API End Point.

Related content