GET api/Profile?systemName={systemName}&username={username}&password={password}&guid={guid}

Read profile

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

guid

string

Required

Body Parameters

None.

Response Information

Resource Description

APIProfile
NameDescriptionTypeAdditional information
Guid

Textual identifier

string

None.

Gender

Gender of user associated to profile: Male, Female or Unknown

string

None.

Age

Age of user associated to profile

integer

None.

Income

Income of user associated to profile

integer

None.

Frequency

List of APIProfileFrequency

Collection of APIProfileFrequency

None.

Interval

List of APIProfileInterval

Collection of APIProfileInterval

None.

Retarget

List of APIProfileRetarget

Collection of APIProfileRetarget

None.

Beacon

List of APIProfileBeacon

Collection of APIProfileBeacon

None.

Response Formats

application/json, text/json

Sample:
{
  "guid": "sample string 1",
  "gender": "sample string 2",
  "age": 1,
  "income": 1,
  "frequency": [
    {
      "type": "sample string 1",
      "id": 2,
      "expiry": "sample string 3",
      "limit": 4,
      "count": 5
    },
    {
      "type": "sample string 1",
      "id": 2,
      "expiry": "sample string 3",
      "limit": 4,
      "count": 5
    }
  ],
  "interval": [
    {
      "type": "sample string 1",
      "id": 2,
      "expiry": "sample string 3"
    },
    {
      "type": "sample string 1",
      "id": 2,
      "expiry": "sample string 3"
    }
  ],
  "retarget": [
    {
      "id": 1,
      "expiry": "sample string 2",
      "limit": 3,
      "count": 4
    },
    {
      "id": 1,
      "expiry": "sample string 2",
      "limit": 3,
      "count": 4
    }
  ],
  "beacon": [
    {
      "id": 1,
      "expiry": "sample string 2",
      "limit": 3,
      "count": 4
    },
    {
      "id": 1,
      "expiry": "sample string 2",
      "limit": 3,
      "count": 4
    }
  ]
}

application/xml, text/xml

Sample:
<APIProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <Age>1</Age>
  <Beacon>
    <APIProfileBeacon>
      <Count>4</Count>
      <Expiry>sample string 2</Expiry>
      <Id>1</Id>
      <Limit>3</Limit>
    </APIProfileBeacon>
    <APIProfileBeacon>
      <Count>4</Count>
      <Expiry>sample string 2</Expiry>
      <Id>1</Id>
      <Limit>3</Limit>
    </APIProfileBeacon>
  </Beacon>
  <Frequency>
    <APIProfileFrequency>
      <Count>5</Count>
      <Expiry>sample string 3</Expiry>
      <Id>2</Id>
      <Limit>4</Limit>
      <Type>sample string 1</Type>
    </APIProfileFrequency>
    <APIProfileFrequency>
      <Count>5</Count>
      <Expiry>sample string 3</Expiry>
      <Id>2</Id>
      <Limit>4</Limit>
      <Type>sample string 1</Type>
    </APIProfileFrequency>
  </Frequency>
  <Gender>sample string 2</Gender>
  <Guid>sample string 1</Guid>
  <Income>1</Income>
  <Interval>
    <APIProfileInterval>
      <Expiry>sample string 3</Expiry>
      <Id>2</Id>
      <Type>sample string 1</Type>
    </APIProfileInterval>
    <APIProfileInterval>
      <Expiry>sample string 3</Expiry>
      <Id>2</Id>
      <Type>sample string 1</Type>
    </APIProfileInterval>
  </Interval>
  <Retarget>
    <APIProfileRetarget>
      <Count>4</Count>
      <Expiry>sample string 2</Expiry>
      <Id>1</Id>
      <Limit>3</Limit>
    </APIProfileRetarget>
    <APIProfileRetarget>
      <Count>4</Count>
      <Expiry>sample string 2</Expiry>
      <Id>1</Id>
      <Limit>3</Limit>
    </APIProfileRetarget>
  </Retarget>
</APIProfile>