GET api/contactgroup/{contactGroupId}

Request Information

URI Parameters

Name	Description	Type	Additional information
contactGroupId		integer	Required

Body Parameters

None.

Response Information

Resource Description

ContactGroup

Name	Type	Additional information
Id	integer	None.
Reference	string	None.
Active	boolean	None.
Summary	ContactGroupSummary	None.
PrimaryContact	Contact	None.
SecondaryContact	Contact	None.
Contacts	Collection of Contact	None.
Permissions	Permissions	None.
MarketingTypes	Collection of MarketingType	None.
OriginMarketingTypes	Collection of MarketingType	None.
AutomatorTypes	Collection of MarketingType	None.
IsOwner	boolean	None.
IsInvestor	boolean	None.
LookingToRent	boolean	None.
LookingToBuy	boolean	None.
Origin	string	None.

Response Formats

application/json, text/json

Sample:

{
  "origin": "sample string 1",
  "id": 1,
  "reference": "sample string 2",
  "active": true,
  "summary": {
    "id": 1,
    "active": true,
    "reference": "sample string 2",
    "displayName": "sample string 3",
    "name": "sample string 4",
    "firstName": "sample string 5",
    "category": "MARRIED_COUPLE",
    "categoryDescription": "sample string 6",
    "email": "sample string 7",
    "phone": "sample string 8",
    "mobilePhone": "sample string 9",
    "languageId": "sample string 10",
    "stealth": true,
    "address": {
      "longitude": "sample string 1",
      "latitude": "sample string 2",
      "id": 1,
      "street": "sample string 1",
      "houseNumber": 1,
      "houseNumberExtension": "sample string 2",
      "mailBox": "sample string 3",
      "city": "sample string 4",
      "zipCode": "sample string 5",
      "countryCode": "AD",
      "residence": "sample string 6"
    },
    "accessDenied": true
  },
  "primaryContact": {
    "id": 1,
    "name": "sample string 1",
    "firstName": "sample string 2",
    "linkTypeDescription": "sample string 3",
    "linkType": "sample string 4",
    "phone": "sample string 5",
    "mobilePhone": "sample string 6",
    "email": "sample string 7",
    "languageId": "sample string 8",
    "address": {
      "longitude": "sample string 1",
      "latitude": "sample string 2",
      "id": 1,
      "street": "sample string 1",
      "houseNumber": 1,
      "houseNumberExtension": "sample string 2",
      "mailBox": "sample string 3",
      "city": "sample string 4",
      "zipCode": "sample string 5",
      "countryCode": "AD",
      "residence": "sample string 6"
    },
    "gender": "FEMALE"
  },
  "secondaryContact": {
    "id": 1,
    "name": "sample string 1",
    "firstName": "sample string 2",
    "linkTypeDescription": "sample string 3",
    "linkType": "sample string 4",
    "phone": "sample string 5",
    "mobilePhone": "sample string 6",
    "email": "sample string 7",
    "languageId": "sample string 8",
    "address": {
      "longitude": "sample string 1",
      "latitude": "sample string 2",
      "id": 1,
      "street": "sample string 1",
      "houseNumber": 1,
      "houseNumberExtension": "sample string 2",
      "mailBox": "sample string 3",
      "city": "sample string 4",
      "zipCode": "sample string 5",
      "countryCode": "AD",
      "residence": "sample string 6"
    },
    "gender": "FEMALE"
  },
  "contacts": [
    {
      "id": 1,
      "name": "sample string 1",
      "firstName": "sample string 2",
      "linkTypeDescription": "sample string 3",
      "linkType": "sample string 4",
      "phone": "sample string 5",
      "mobilePhone": "sample string 6",
      "email": "sample string 7",
      "languageId": "sample string 8",
      "address": {
        "longitude": "sample string 1",
        "latitude": "sample string 2",
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "city": "sample string 4",
        "zipCode": "sample string 5",
        "countryCode": "AD",
        "residence": "sample string 6"
      },
      "gender": "FEMALE"
    },
    {
      "id": 1,
      "name": "sample string 1",
      "firstName": "sample string 2",
      "linkTypeDescription": "sample string 3",
      "linkType": "sample string 4",
      "phone": "sample string 5",
      "mobilePhone": "sample string 6",
      "email": "sample string 7",
      "languageId": "sample string 8",
      "address": {
        "longitude": "sample string 1",
        "latitude": "sample string 2",
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "city": "sample string 4",
        "zipCode": "sample string 5",
        "countryCode": "AD",
        "residence": "sample string 6"
      },
      "gender": "FEMALE"
    }
  ],
  "permissions": {
    "create": true,
    "read": true,
    "update": true,
    "delete": true
  },
  "marketingTypes": [
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    },
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    }
  ],
  "originMarketingTypes": [
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    },
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    }
  ],
  "automatorTypes": [
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    },
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    }
  ],
  "isOwner": true,
  "isInvestor": true,
  "lookingToRent": true,
  "lookingToBuy": true
}

application/xml, text/xml

Sample:

<ContactGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Active>true</Active>
  <AutomatorTypes>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
  </AutomatorTypes>
  <Contacts>
    <Contact>
      <Address>
        <City>sample string 4</City>
        <CountryCode>AD</CountryCode>
        <HouseNumber>1</HouseNumber>
        <HouseNumberExtension>sample string 2</HouseNumberExtension>
        <Id>1</Id>
        <Latitude>sample string 2</Latitude>
        <Longitude>sample string 1</Longitude>
        <MailBox>sample string 3</MailBox>
        <Residence>sample string 6</Residence>
        <Street>sample string 1</Street>
        <ZipCode>sample string 5</ZipCode>
      </Address>
      <Email>sample string 7</Email>
      <FirstName>sample string 2</FirstName>
      <Gender>FEMALE</Gender>
      <Id>1</Id>
      <LanguageId>sample string 8</LanguageId>
      <LinkType>sample string 4</LinkType>
      <LinkTypeDescription>sample string 3</LinkTypeDescription>
      <MobilePhone>sample string 6</MobilePhone>
      <Name>sample string 1</Name>
      <Phone>sample string 5</Phone>
    </Contact>
    <Contact>
      <Address>
        <City>sample string 4</City>
        <CountryCode>AD</CountryCode>
        <HouseNumber>1</HouseNumber>
        <HouseNumberExtension>sample string 2</HouseNumberExtension>
        <Id>1</Id>
        <Latitude>sample string 2</Latitude>
        <Longitude>sample string 1</Longitude>
        <MailBox>sample string 3</MailBox>
        <Residence>sample string 6</Residence>
        <Street>sample string 1</Street>
        <ZipCode>sample string 5</ZipCode>
      </Address>
      <Email>sample string 7</Email>
      <FirstName>sample string 2</FirstName>
      <Gender>FEMALE</Gender>
      <Id>1</Id>
      <LanguageId>sample string 8</LanguageId>
      <LinkType>sample string 4</LinkType>
      <LinkTypeDescription>sample string 3</LinkTypeDescription>
      <MobilePhone>sample string 6</MobilePhone>
      <Name>sample string 1</Name>
      <Phone>sample string 5</Phone>
    </Contact>
  </Contacts>
  <Id>1</Id>
  <IsInvestor>true</IsInvestor>
  <IsOwner>true</IsOwner>
  <LookingToBuy>true</LookingToBuy>
  <LookingToRent>true</LookingToRent>
  <MarketingTypes>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
  </MarketingTypes>
  <Origin>sample string 1</Origin>
  <OriginMarketingTypes>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
  </OriginMarketingTypes>
  <Permissions>
    <Create>true</Create>
    <Delete>true</Delete>
    <Read>true</Read>
    <Update>true</Update>
  </Permissions>
  <PrimaryContact>
    <Address>
      <City>sample string 4</City>
      <CountryCode>AD</CountryCode>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>sample string 2</HouseNumberExtension>
      <Id>1</Id>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
      <MailBox>sample string 3</MailBox>
      <Residence>sample string 6</Residence>
      <Street>sample string 1</Street>
      <ZipCode>sample string 5</ZipCode>
    </Address>
    <Email>sample string 7</Email>
    <FirstName>sample string 2</FirstName>
    <Gender>FEMALE</Gender>
    <Id>1</Id>
    <LanguageId>sample string 8</LanguageId>
    <LinkType>sample string 4</LinkType>
    <LinkTypeDescription>sample string 3</LinkTypeDescription>
    <MobilePhone>sample string 6</MobilePhone>
    <Name>sample string 1</Name>
    <Phone>sample string 5</Phone>
  </PrimaryContact>
  <Reference>sample string 2</Reference>
  <SecondaryContact>
    <Address>
      <City>sample string 4</City>
      <CountryCode>AD</CountryCode>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>sample string 2</HouseNumberExtension>
      <Id>1</Id>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
      <MailBox>sample string 3</MailBox>
      <Residence>sample string 6</Residence>
      <Street>sample string 1</Street>
      <ZipCode>sample string 5</ZipCode>
    </Address>
    <Email>sample string 7</Email>
    <FirstName>sample string 2</FirstName>
    <Gender>FEMALE</Gender>
    <Id>1</Id>
    <LanguageId>sample string 8</LanguageId>
    <LinkType>sample string 4</LinkType>
    <LinkTypeDescription>sample string 3</LinkTypeDescription>
    <MobilePhone>sample string 6</MobilePhone>
    <Name>sample string 1</Name>
    <Phone>sample string 5</Phone>
  </SecondaryContact>
  <Summary>
    <AccessDenied>true</AccessDenied>
    <Active>true</Active>
    <Address>
      <City>sample string 4</City>
      <CountryCode>AD</CountryCode>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>sample string 2</HouseNumberExtension>
      <Id>1</Id>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
      <MailBox>sample string 3</MailBox>
      <Residence>sample string 6</Residence>
      <Street>sample string 1</Street>
      <ZipCode>sample string 5</ZipCode>
    </Address>
    <Category>MARRIED_COUPLE</Category>
    <CategoryDescription>sample string 6</CategoryDescription>
    <DisplayName>sample string 3</DisplayName>
    <Email>sample string 7</Email>
    <FirstName>sample string 5</FirstName>
    <Id>1</Id>
    <LanguageId>sample string 10</LanguageId>
    <MobilePhone>sample string 9</MobilePhone>
    <Name>sample string 4</Name>
    <Phone>sample string 8</Phone>
    <Reference>sample string 2</Reference>
    <Stealth>true</Stealth>
  </Summary>
</ContactGroup>