POST api/CompanyEmployeeLink?APIGUID={APIGUID}&GetCall={GetCall}

Retrieves Company/Employee Linked data

Request Information

URI Parameters

Name	Description	Type	Additional information
APIGUID		string	Required
GetCall	Placeholder for GET	string	Required

Body Parameters

Endpoint Access Parameters

EndPointParameters

Name	Type	Additional information
ValidationKey	string	None.
VendorID	string	None.
VendorPassword	string	None.
CompanyKey	integer	None.
CommunityKey	integer	None.
ResidentKey	integer	None.
UnitKey	integer	None.
PrimaryKey	integer	None.
ForeignKey	integer	None.
IncludeClosed	boolean	None.
Date1	date	None.
Date2	date	None.
Date3	date	None.
DeltaDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ValidationKey": "sample string 1",
  "VendorID": "sample string 2",
  "VendorPassword": "sample string 3",
  "CompanyKey": 4,
  "CommunityKey": 5,
  "ResidentKey": 6,
  "UnitKey": 7,
  "PrimaryKey": 8,
  "ForeignKey": 9,
  "IncludeClosed": true,
  "Date1": "2024-09-19T12:21:38.3396631-05:00",
  "Date2": "2024-09-19T12:21:38.3396631-05:00",
  "Date3": "2024-09-19T12:21:38.3396631-05:00",
  "DeltaDate": "2024-09-19T12:21:38.3396631-05:00"
}

application/xml, text/xml

Sample:

<EndPointParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesAuthentication">
  <CommunityKey>5</CommunityKey>
  <CompanyKey>4</CompanyKey>
  <Date1>2024-09-19T12:21:38.3396631-05:00</Date1>
  <Date2>2024-09-19T12:21:38.3396631-05:00</Date2>
  <Date3>2024-09-19T12:21:38.3396631-05:00</Date3>
  <DeltaDate>2024-09-19T12:21:38.3396631-05:00</DeltaDate>
  <ForeignKey>9</ForeignKey>
  <IncludeClosed>true</IncludeClosed>
  <PrimaryKey>8</PrimaryKey>
  <ResidentKey>6</ResidentKey>
  <UnitKey>7</UnitKey>
  <ValidationKey>sample string 1</ValidationKey>
  <VendorID>sample string 2</VendorID>
  <VendorPassword>sample string 3</VendorPassword>
</EndPointParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.