Retrieve a List of Phone Types

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 5, 2017
Version 2Show Document
  • View in full screen mode

Overview

This API allows you to retrieve the list of all the platforms present in the PubMatic system.

Request

         

URIhttp://{domainName}/common/phoneType?pageSize=20&pageNumber=1
HTTP MethodGET

Request Headers

                 

Header NameTypeValueRequiredDescription
AuthorizationStringBearer ${access_token}YesNeed to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Query Parameters

                     

Parameter NameTypeRequiredDescription
pageNumberIntegerOptional
Page number to be fetched in case of multiple pages.
Its default value is 1.
pageSizeIntegerOptional
Maximum number of rows to be included in the response.
Its default value is 100.

Response

Response Headers

           

Response Header NameType
Content-typeapplication-json

Response Body

                       

Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique identifier of the platform.
nameStringName of the platform.

Sample Response JSON

 

{
    "metaData": {
       "startIndex": 1,
       "request": {
          "pageSize": 3,
          "pageNumber": 1
       },
       "totalRecords": 2,
       "endIndex": 2
    },
    "items": [
       {
          "id": 1,
          "name": "Feature Phone"
       },
       {
          "id": 2,
          "name": "Smart Phone"
       }
    ]
  }

Error Codes

Error codes specific to this API method.

               

Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found

Attachments

    Outcomes