Get Profile

Request

The get profile request is specified as follows:


URI	https://api.imiconnect.io/resources/v1/customerprofile/ customerid: A client specific ID (such as CRN) to uniquely identify a customer.
Method	GET

URI Parameters

Parameter	Description
showinwardlinks	Extended information within the customer profile in the inwardlinks section can be retrieved as part of the request. The inwardlink section contains channel specific attributes that are linked to the customer profile (e.g. Facebook and Twitter etc.). The values are: 0: Retrieve master profile only. 1: Retrieve master profile and application profiles. 2: Retrieve full profile.

Request Headers

The following table describes the request headers:

Request Header	Description
key	Client profile key
content-type	application/json

##Request Example

https://api.imiconnect.io/resources/v1/customerprofile/4545?showinwardlinks=0

https://api.imiconnect.io/resources/v1/customerprofile?customerId=2134&customerId=2142&showinwardlinks=0

Request Body

The following table describes the elements in the request URL:

Parameter	Type	Mandatory	Description
customerid	String	Yes	A client specific ID (such as CRN) to uniquely identify a customer.

##Response Examples

{
  "Status": 0,
  "Description": "success",
  "Records": [
    {
      "Attributes": [
        {
          "Name": "msisdn",
          "Value": "91900007707",
          "ID": 8574
        },
        {
          "Name": "email",
          "Value": "[email protected]",
          "ID": 8575
        },
        {
          "Name": "name",
          "Value": "john",
          "ID": 8576
        },
        {
          "Name": "customerId",
          "Value": "4545",
          "ID": 8577
        },
        {
          "Name": "sms",
          "Value": "1",
          "ID": 8578
        },
        {
          "Name": "voice",
          "Value": "1",
          "ID": 8579
        },
        {
          "Name": "rt",
          "Value": "1",
          "ID": 8580
        },
        {
          "Name": "fb",
          "Value": "1",
          "ID": 8581
        },
        {
          "Name": "twitter",
          "Value": "1",
          "ID": 8582
        },
        {
          "Name": "wechat",
          "Value": "1",
          "ID": 8583
        },
        {
          "Name": "wa",
          "Value": "1",
          "ID": 8584
        }
      ],
      "InwardLinks": [],
      "OutwardLinks": []
    }
  ],
  "code": "1000",
  "transid": "d2708309-75ab-4f18-b5c6-3f23ab9afd43"
}

{
    "Status": 0,
    "Description": "success",
    "Records": [{
        "Attributes": [{
            "Name": "msisdn",
            "Value": "918106565495",
            "ID": 8328
        }, {
            "Name": "email",
            "Value": "[email protected]",
            "ID": 8329
        }, {
            "Name": "name",
            "Value": "jagadeesh",
            "ID": 8330
        }, {
            "Name": "customerId",
            "Value": "2134",
            "ID": 8331
        }, {
            "Name": "sms",
            "Value": "1",
            "ID": 8332
        }, {
            "Name": "voice",
            "Value": "1",
            "ID": 8333
        }, {
            "Name": "ussd",
            "Value": "1",
            "ID": 8334
        }, {
            "Name": "rt",
            "Value": "1",
            "ID": 8335
        }, {
            "Name": "fb",
            "Value": "1",
            "ID": 8336
        }, {
            "Name": "fbc",
            "Value": "1",
            "ID": 8337
        }, {
            "Name": "twitter",
            "Value": "1",
            "ID": 8338
        }, {
            "Name": "mxit",
            "Value": "1",
            "ID": 8339
        }, {
            "Name": "wechat",
            "Value": "1",
            "ID": 8340
        }, {
            "Name": "wa",
            "Value": "1",
            "ID": 8341
        }],
        "InwardLinks": [],
        "OutwardLinks": []
    }, {
        "Attributes": [{
            "Name": "msisdn",
            "Value": "919963427038",
            "ID": 8328
        }, {
            "Name": "email",
            "Value": "[email protected]",
            "ID": 8329
        }, {
            "Name": "name",
            "Value": "balaji",
            "ID": 8330
        }, {
            "Name": "customerId",
            "Value": "2142",
            "ID": 8331
        }, {
            "Name": "sms",
            "Value": "1",
            "ID": 8332
        }, {
            "Name": "voice",
            "Value": "1",
            "ID": 8333
        }, {
            "Name": "ussd",
            "Value": "1",
            "ID": 8334
        }, {
            "Name": "rt",
            "Value": "1",
            "ID": 8335
        }, {
            "Name": "fb",
            "Value": "1",
            "ID": 8336
        }, {
            "Name": "fbc",
            "Value": "1",
            "ID": 8337
        }, {
            "Name": "twitter",
            "Value": "1",
            "ID": 8338
        }, {
            "Name": "mxit",
            "Value": "1",
            "ID": 8339
        }, {
            "Name": "wechat",
            "Value": "1",
            "ID": 8340
        }, {
            "Name": "wa",
            "Value": "1",
            "ID": 8341
        }],
        "InwardLinks": [],
        "OutwardLinks": []
    }],
    "code": "1000",
    "transid": "236fe39b-78b0-4f94-bcda-270cdd01ab9a"
}

Status Codes

This API may return the following response codes:

Response Code	Message	Description
1000	Success	Returned when the request is completed successfully.
7000	Invalid JSON	Returned when an invalid JSON request is sent.
7001	Authentication failed	Returned when the invalid service key or profile key is provided in the request.
7003	Mandatory parameters missing	Click here