GET api/Badges?contactId={contactId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

System.Guid

Required

Body Parameters

None.

Response Information

Resource Description

System.Collections.Generic.ICollection`1[Altai.Web.Services.Models.Badge]
NameDescriptionTypeAdditional information
Id

System.Guid

None.

Status

Altai.Web.Services.Models.OptionSetValue

None.

Program

Altai.Web.Services.Models.Program

None.

Name

System.String

None.

BadgeUrl

System.String

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "490266fe-9ec8-479c-befa-f9e9522fb358",
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Program": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "Type": "sample string 4",
      "ProgramGroup": "sample string 5",
      "BillingTermLength": 6,
      "ActivePriceListId": "sample string 7",
      "BachelorsDegreeMonthsRequired": 8,
      "DoctorateDegreeMonthsRequired": 9,
      "HighSchoolMonthsRequired": 10,
      "MastersDegreeMonthsRequired": 11
    },
    "Name": "sample string 2",
    "BadgeUrl": "sample string 3"
  },
  {
    "Id": "490266fe-9ec8-479c-befa-f9e9522fb358",
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Program": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "Type": "sample string 4",
      "ProgramGroup": "sample string 5",
      "BillingTermLength": 6,
      "ActivePriceListId": "sample string 7",
      "BachelorsDegreeMonthsRequired": 8,
      "DoctorateDegreeMonthsRequired": 9,
      "HighSchoolMonthsRequired": 10,
      "MastersDegreeMonthsRequired": 11
    },
    "Name": "sample string 2",
    "BadgeUrl": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBadge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Badge>
    <BadgeUrl>sample string 3</BadgeUrl>
    <Id>490266fe-9ec8-479c-befa-f9e9522fb358</Id>
    <Name>sample string 2</Name>
    <Program>
      <ActivePriceListId>sample string 7</ActivePriceListId>
      <BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
      <BillingTermLength>6</BillingTermLength>
      <DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
      <HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
      <Id>sample string 1</Id>
      <MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
      <Name>sample string 2</Name>
      <ProgramGroup>sample string 5</ProgramGroup>
      <ShortName>sample string 3</ShortName>
      <Type>sample string 4</Type>
    </Program>
    <Status>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Status>
  </Badge>
  <Badge>
    <BadgeUrl>sample string 3</BadgeUrl>
    <Id>490266fe-9ec8-479c-befa-f9e9522fb358</Id>
    <Name>sample string 2</Name>
    <Program>
      <ActivePriceListId>sample string 7</ActivePriceListId>
      <BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
      <BillingTermLength>6</BillingTermLength>
      <DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
      <HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
      <Id>sample string 1</Id>
      <MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
      <Name>sample string 2</Name>
      <ProgramGroup>sample string 5</ProgramGroup>
      <ShortName>sample string 3</ShortName>
      <Type>sample string 4</Type>
    </Program>
    <Status>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Status>
  </Badge>
</ArrayOfBadge>