POST api/v1/PatientInsurance/InterfacePatientInsurance

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LocationCode	string	None.
PatientKey	string	None.
InsuranceKey	string	None.
InsuranceName	string	None.
InsuranceType	string	None.
InsurancePhone	string	None.
InsuranceAddress1	string	None.
InsuranceAddress2	string	None.
InsuranceCity	string	None.
InsuranceState	string	None.
InsuranceZip	string	None.
PolicyNumber	string	None.
PolicyGroup	string	None.
TypeOfPlan	string	None.
EffectiveDate	date	None.
TerminationDate	date	None.
PolicyHolder	string	None.
InsuredEmployer	string	None.
InsuredName	string	None.
InsuredSocial	string	None.
InsuredDateOfBirth	date	None.
InsuredGender	string	None.
IsActive	boolean	None.
ElectronicPayerId	string	None.
InsuranceNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LocationCode": "sample string 1",
  "PatientKey": "sample string 2",
  "InsuranceKey": "sample string 3",
  "InsuranceName": "sample string 4",
  "InsuranceType": "sample string 5",
  "InsurancePhone": "sample string 6",
  "InsuranceAddress1": "sample string 7",
  "InsuranceAddress2": "sample string 8",
  "InsuranceCity": "sample string 9",
  "InsuranceState": "sample string 10",
  "InsuranceZip": "sample string 11",
  "PolicyNumber": "sample string 12",
  "PolicyGroup": "sample string 13",
  "TypeOfPlan": "sample string 14",
  "EffectiveDate": "2026-04-14T06:05:21.6134534+00:00",
  "TerminationDate": "2026-04-14T06:05:21.6138234+00:00",
  "PolicyHolder": "sample string 15",
  "InsuredEmployer": "sample string 16",
  "InsuredName": "sample string 17",
  "InsuredSocial": "sample string 18",
  "InsuredDateOfBirth": "2026-04-14T06:05:21.6138234+00:00",
  "InsuredGender": "sample string 19",
  "IsActive": true,
  "ElectronicPayerId": "sample string 20",
  "InsuranceNumber": 1
}

application/xml, text/xml

Sample:

<PatientInsuranceInterfaceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AimsApi.ViewModels.PatientInsurance">
  <EffectiveDate>2026-04-14T06:05:21.6134534+00:00</EffectiveDate>
  <ElectronicPayerId>sample string 20</ElectronicPayerId>
  <InsuranceAddress1>sample string 7</InsuranceAddress1>
  <InsuranceAddress2>sample string 8</InsuranceAddress2>
  <InsuranceCity>sample string 9</InsuranceCity>
  <InsuranceKey>sample string 3</InsuranceKey>
  <InsuranceName>sample string 4</InsuranceName>
  <InsuranceNumber>1</InsuranceNumber>
  <InsurancePhone>sample string 6</InsurancePhone>
  <InsuranceState>sample string 10</InsuranceState>
  <InsuranceType>sample string 5</InsuranceType>
  <InsuranceZip>sample string 11</InsuranceZip>
  <InsuredDateOfBirth>2026-04-14T06:05:21.6138234+00:00</InsuredDateOfBirth>
  <InsuredEmployer>sample string 16</InsuredEmployer>
  <InsuredGender>sample string 19</InsuredGender>
  <InsuredName>sample string 17</InsuredName>
  <InsuredSocial>sample string 18</InsuredSocial>
  <IsActive>true</IsActive>
  <LocationCode>sample string 1</LocationCode>
  <PatientKey>sample string 2</PatientKey>
  <PolicyGroup>sample string 13</PolicyGroup>
  <PolicyHolder>sample string 15</PolicyHolder>
  <PolicyNumber>sample string 12</PolicyNumber>
  <TerminationDate>2026-04-14T06:05:21.6138234+00:00</TerminationDate>
  <TypeOfPlan>sample string 14</TypeOfPlan>
</PatientInsuranceInterfaceRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PatientInsuranceInterfaceRequest'.

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.