Retrieving List of Connection Types

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

Overview

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

Request

         

URI
http://{domainName}/common/connectionType?pageSize=3&pageNumber=1
HTTP Method
GET

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes
Need 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 Name
Type
Required
Description
pageNumber
Integer
Optional
Page number to be fetched in case of multiple pages.
Its default value is 1.
pageSize
Integer
Optional
Maximum number of rows to be included in the response.
Its default value is 100.

Response

Response Headers

           

Response Header Name
Type
Content-type
application-json

Response Body

                       

Response Body Parameter
Type
Description
metaDataObjectPagination details
idIntegerUnique identifier of the connection type.
nameStringName of the connection type.

Sample Response JSON

{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 4,

        "endIndex": 3

    },

    "items": [

        {

            "id": 1,

            "name": "Cable/DSL"

        },

        {

            "id": 2,

            "name": "Cellular"

        },

        {

            "id": 3,

            "name": "Corporate"

        }

    ]

}

Error Codes

Error codes specific to this API method.

               

Error Code
Error Description
CC03_0001
No records found
CC03_0004
Resource not found

Attachments

    Outcomes