POST api/contact/{contactGroupId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactGroupId

integer

Required

Body Parameters

Contact
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

FirstName

string

None.

LinkTypeDescription

string

None.

LinkType

string

None.

Phone

string

None.

MobilePhone

string

None.

Email

string

None.

LanguageId

string

None.

Address

Address

None.

Gender

GenderType

None.

Request Formats

application/json, text/json

Sample:
{
  "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"
}

application/xml, text/xml

Sample:
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactGroupResult
NameDescriptionTypeAdditional information
ContactGroup

ContactGroup

None.

Success

boolean

None.

Status

Errata

None.

Errors

Collection of string

None.

Message

string

None.

StackTrace

string

None.

Exception

Exception

None.

Response Formats

application/json, text/json

Sample:
{
  "contactGroup": {
    "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
  },
  "success": true,
  "status": "OK",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "message": "sample string 2",
  "stackTrace": "sample string 3",
  "exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<Result.ContactGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <StackTrace>sample string 3</StackTrace>
  <Status>OK</Status>
  <Success>true</Success>
  <ContactGroup>
    <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>
</Result.ContactGroupResult>