POST api/Contact/GetContactforGrid

Request Information

URI Parameters

None.

Body Parameters

Contact
NameDescriptionTypeAdditional information
PersonID

integer

None.

FirstName

string

None.

MiddleInitial

string

None.

LastName

string

None.

PrimaryPhone

string

None.

HomePhone

string

None.

MobilePhone

string

None.

Fax

string

None.

PrimaryEmail

string

None.

SecondaryEmail

string

None.

StatusID

integer

None.

StatusName

string

None.

PersonTypeID

integer

None.

PersonTypeName

string

None.

ContactTypeID

integer

None.

ContactTypeName

string

None.

PhysicianTypeID

integer

None.

PhysicianTypeName

string

None.

OrganizationID

integer

None.

OrganizationName

string

None.

IsActive

boolean

None.

PrimaryAddressID

integer

None.

PrimaryCountyId

integer

None.

PrimaryCountyName

string

None.

PrimaryCountryId

integer

None.

PrimaryAddress1

string

None.

PrimaryAddress2

string

None.

PrimaryCountryName

string

None.

PrimaryCity

string

None.

PrimaryStateProvince

string

None.

PrimaryZip

string

None.

AlternateAddressID

integer

None.

AlternateCountyId

integer

None.

AlternateCountyName

string

None.

AlternateCountryId

integer

None.

AlternateCountryName

string

None.

AlternateAddress1

string

None.

AlternateAddress2

string

None.

AlternateCity

string

None.

AlternateStateProvince

string

None.

AlternateZip

string

None.

ActorID

integer

None.

DateEntered

date

None.

EnteredByID

integer

None.

EnteredByName

string

None.

DateUpdated

date

None.

UpdatedByID

integer

None.

UpdatedByName

string

None.

ShortType

string

None.

CF

string

None.

id

string

None.

cfid

string

None.

OrgID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PersonID": 1,
  "FirstName": "sample string 1",
  "MiddleInitial": "sample string 2",
  "LastName": "sample string 3",
  "PrimaryPhone": "sample string 4",
  "HomePhone": "sample string 5",
  "MobilePhone": "sample string 6",
  "Fax": "sample string 7",
  "PrimaryEmail": "sample string 8",
  "SecondaryEmail": "sample string 9",
  "StatusID": 1,
  "StatusName": "sample string 10",
  "PersonTypeID": 1,
  "PersonTypeName": "sample string 11",
  "ContactTypeID": 1,
  "ContactTypeName": "sample string 12",
  "PhysicianTypeID": 1,
  "PhysicianTypeName": "sample string 13",
  "OrganizationID": 1,
  "OrganizationName": "sample string 14",
  "IsActive": true,
  "PrimaryAddressID": 1,
  "PrimaryCountyId": 1,
  "PrimaryCountyName": "sample string 15",
  "PrimaryCountryId": 1,
  "PrimaryAddress1": "sample string 16",
  "PrimaryAddress2": "sample string 17",
  "PrimaryCountryName": "sample string 18",
  "PrimaryCity": "sample string 19",
  "PrimaryStateProvince": "sample string 20",
  "PrimaryZip": "sample string 21",
  "AlternateAddressID": 1,
  "AlternateCountyId": 1,
  "AlternateCountyName": "sample string 22",
  "AlternateCountryId": 1,
  "AlternateCountryName": "sample string 23",
  "AlternateAddress1": "sample string 24",
  "AlternateAddress2": "sample string 25",
  "AlternateCity": "sample string 26",
  "AlternateStateProvince": "sample string 27",
  "AlternateZip": "sample string 28",
  "ActorID": 1,
  "DateEntered": "2025-10-25T14:29:45.1071417-07:00",
  "EnteredByID": 1,
  "EnteredByName": "sample string 29",
  "DateUpdated": "2025-10-25T14:29:45.1071417-07:00",
  "UpdatedByID": 1,
  "UpdatedByName": "sample string 30",
  "ShortType": "sample string 31",
  "CF": "sample string 32",
  "id": "sample string 33",
  "cfid": "sample string 34",
  "OrgID": 1
}

application/xml, text/xml

Sample:
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BKS.CTMS.MODEL">
  <ActorID>1</ActorID>
  <AlternateAddress1>sample string 24</AlternateAddress1>
  <AlternateAddress2>sample string 25</AlternateAddress2>
  <AlternateAddressID>1</AlternateAddressID>
  <AlternateCity>sample string 26</AlternateCity>
  <AlternateCountryId>1</AlternateCountryId>
  <AlternateCountryName>sample string 23</AlternateCountryName>
  <AlternateCountyId>1</AlternateCountyId>
  <AlternateCountyName>sample string 22</AlternateCountyName>
  <AlternateStateProvince>sample string 27</AlternateStateProvince>
  <AlternateZip>sample string 28</AlternateZip>
  <CF>sample string 32</CF>
  <ContactTypeID>1</ContactTypeID>
  <ContactTypeName>sample string 12</ContactTypeName>
  <DateEntered>2025-10-25T14:29:45.1071417-07:00</DateEntered>
  <DateUpdated>2025-10-25T14:29:45.1071417-07:00</DateUpdated>
  <EnteredByID>1</EnteredByID>
  <EnteredByName>sample string 29</EnteredByName>
  <Fax>sample string 7</Fax>
  <FirstName>sample string 1</FirstName>
  <HomePhone>sample string 5</HomePhone>
  <IsActive>true</IsActive>
  <LastName>sample string 3</LastName>
  <MiddleInitial>sample string 2</MiddleInitial>
  <MobilePhone>sample string 6</MobilePhone>
  <OrgID>1</OrgID>
  <OrganizationID>1</OrganizationID>
  <OrganizationName>sample string 14</OrganizationName>
  <PersonID>1</PersonID>
  <PersonTypeID>1</PersonTypeID>
  <PersonTypeName>sample string 11</PersonTypeName>
  <PhysicianTypeID>1</PhysicianTypeID>
  <PhysicianTypeName>sample string 13</PhysicianTypeName>
  <PrimaryAddress1>sample string 16</PrimaryAddress1>
  <PrimaryAddress2>sample string 17</PrimaryAddress2>
  <PrimaryAddressID>1</PrimaryAddressID>
  <PrimaryCity>sample string 19</PrimaryCity>
  <PrimaryCountryId>1</PrimaryCountryId>
  <PrimaryCountryName>sample string 18</PrimaryCountryName>
  <PrimaryCountyId>1</PrimaryCountyId>
  <PrimaryCountyName>sample string 15</PrimaryCountyName>
  <PrimaryEmail>sample string 8</PrimaryEmail>
  <PrimaryPhone>sample string 4</PrimaryPhone>
  <PrimaryStateProvince>sample string 20</PrimaryStateProvince>
  <PrimaryZip>sample string 21</PrimaryZip>
  <SecondaryEmail>sample string 9</SecondaryEmail>
  <ShortType>sample string 31</ShortType>
  <StatusID>1</StatusID>
  <StatusName>sample string 10</StatusName>
  <UpdatedByID>1</UpdatedByID>
  <UpdatedByName>sample string 30</UpdatedByName>
  <cfid>sample string 34</cfid>
  <id>sample string 33</id>
</Contact>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.