GET api/contacts/demographics?contactId={contactId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ContactDemographics
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

BirthDate

date

None.

Gender

OptionSetValueModel

None.

Country

Country

None.

City

string

None.

Street1

string

None.

Street2

string

None.

PostalCode

string

None.

PrimaryPhone

string

None.

PrimaryPhoneType

OptionSetValueModel

None.

State

StateProvince

None.

Province

string

None.

SecondaryPhone

string

None.

SecondaryPhoneType

OptionSetValueModel

None.

MilitaryBackground

OptionSetValueModel

None.

MilitaryBranch

OptionSetValueModel

None.

MilitaryGrade

OptionSetValueModel

None.

MilitaryLength

OptionSetValueModel

None.

MilitaryStatus

OptionSetValueModel

None.

IsExamAppInProcess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "0dc5c439-370c-4589-b12a-9640fdf957cc",
  "BirthDate": "2024-11-15T19:43:22.2223196-05:00",
  "Gender": {
    "Label": "sample string 1",
    "Value": 2
  },
  "Country": {
    "Code": "sample string 1",
    "Id": "sample string 2",
    "Name": "sample string 3",
    "EmbargoCountry": true,
    "APPresScreen": true,
    "hasStates": true
  },
  "City": "sample string 2",
  "Street1": "sample string 3",
  "Street2": "sample string 4",
  "PostalCode": "sample string 5",
  "PrimaryPhone": "sample string 6",
  "PrimaryPhoneType": {
    "Label": "sample string 1",
    "Value": 2
  },
  "State": {
    "Code": "sample string 1",
    "Country": {
      "Code": "sample string 1",
      "Id": "sample string 2",
      "Name": "sample string 3",
      "EmbargoCountry": true,
      "APPresScreen": true,
      "hasStates": true
    },
    "Id": "sample string 2",
    "Name": "sample string 3"
  },
  "Province": "sample string 7",
  "SecondaryPhone": "sample string 8",
  "SecondaryPhoneType": {
    "Label": "sample string 1",
    "Value": 2
  },
  "MilitaryBackground": {
    "Label": "sample string 1",
    "Value": 2
  },
  "MilitaryBranch": {
    "Label": "sample string 1",
    "Value": 2
  },
  "MilitaryGrade": {
    "Label": "sample string 1",
    "Value": 2
  },
  "MilitaryLength": {
    "Label": "sample string 1",
    "Value": 2
  },
  "MilitaryStatus": {
    "Label": "sample string 1",
    "Value": 2
  },
  "IsExamAppInProcess": true
}

application/xml, text/xml

Sample:
<ContactDemographics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <BirthDate>2024-11-15T19:43:22.2223196-05:00</BirthDate>
  <City>sample string 2</City>
  <Country>
    <APPresScreen>true</APPresScreen>
    <Code>sample string 1</Code>
    <EmbargoCountry>true</EmbargoCountry>
    <Id>sample string 2</Id>
    <Name>sample string 3</Name>
    <hasStates>true</hasStates>
  </Country>
  <Gender xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </Gender>
  <Id>0dc5c439-370c-4589-b12a-9640fdf957cc</Id>
  <IsExamAppInProcess>true</IsExamAppInProcess>
  <MilitaryBackground xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </MilitaryBackground>
  <MilitaryBranch xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </MilitaryBranch>
  <MilitaryGrade xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </MilitaryGrade>
  <MilitaryLength xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </MilitaryLength>
  <MilitaryStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </MilitaryStatus>
  <PostalCode>sample string 5</PostalCode>
  <PrimaryPhone>sample string 6</PrimaryPhone>
  <PrimaryPhoneType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </PrimaryPhoneType>
  <Province>sample string 7</Province>
  <SecondaryPhone>sample string 8</SecondaryPhone>
  <SecondaryPhoneType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Label>sample string 1</d2p1:Label>
    <d2p1:Value>2</d2p1:Value>
  </SecondaryPhoneType>
  <State>
    <Code>sample string 1</Code>
    <Country>
      <APPresScreen>true</APPresScreen>
      <Code>sample string 1</Code>
      <EmbargoCountry>true</EmbargoCountry>
      <Id>sample string 2</Id>
      <Name>sample string 3</Name>
      <hasStates>true</hasStates>
    </Country>
    <Id>sample string 2</Id>
    <Name>sample string 3</Name>
  </State>
  <Street1>sample string 3</Street1>
  <Street2>sample string 4</Street2>
</ContactDemographics>