Skip to content

Profile attribute

Borja Gorriz edited this page Sep 23, 2013 · 4 revisions

Base URL: api/dime/rest/{mainSaId}/profileattribute

Method Path Description
GET {personId}/@all Returns a collection of all profile attributes from all profiles the person has.
POST {PId} Creates a new profile attribute into a profile. In case the profileid is “@me”, the profile attribute will be created in the default profile
GET {personId}/{Patid} Returns a specific profile attribute from the person.
GET {PId}/{Patid} Returns a specific profile attribute from an specific profile.
POST {personId}/{Patid} Updates a specific profile attribute from the person.
POST {PId}/{Patid} Updates a specific profile attribute from an specific profile.
DELETE @me/{Patid} Deletes a specific profile attribute.
DELETE {PId}/{Patid} Deletes a specific profile attribute from an specific profile.

Parameters:

  • personId: Id of an specific person. It includes @me.
  • Pid: Id of an specific profile.
  • Patid: Id of an specific profile attribute.

Examples:

  • Call: api/dime/rest/5b223cde-07e5-4987-b531-231876fa7601/profileattribute/@me/@all
  • Response:
{
   "response":{
      "meta":{
         "v":"0.9",
         "status":"OK",
         "code":200,
         "timeRef":"2011-08-30T15:01:59+02:00",
         "msg": ""
   },
   "data":{
      "startIndex":0,
      "itemsPerPage":2,
      "totalResults":2,
      "entry": {
        "guid": "<profileAttrId>",
        "created": 1338824999,
        "lastModified":1338824999,
        "name": "Business-Email",
        "userId":"<userId>|@me",
        "imageUrl": "<imageUrl>",
        "type": "profileattribute",
        "items": [],
        "value": [
            "property1":"valueProperty1",
            "property2":"valueProperty2"],
        "category":"<entity>",
        "predicate":"<predicate>"
      }
    }
}

Clone this wiki locally