PATCH api/members/{id}
Patches an existing member
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Member Identifier |
integer |
Required |
Body Parameters
The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target rule
JsonPatchDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/json-patch+json
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A patched member
MemberModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Salutation |
Gets or sets the salutation for this person. |
string |
None. |
| FirstName |
Gets or sets the first name for this person. |
string |
None. |
| MiddleName |
Gets or sets the middle name for this person. |
string |
None. |
| LastName |
Gets or sets the last name for this person. |
string |
None. |
| Suffix |
Gets or sets the suffix for this person. |
string |
None. |
| EmailAddress |
Gets or sets the email address for this person. |
string |
None. |
| Gender |
Gets or sets the gender for this person. |
string |
None. |
| HeightInches |
Gets or sets the height in inches for this person. |
integer |
None. |
| SSN |
Gets or sets the social security number for this person. |
string |
None. |
| DoNotEmail |
Gets or sets the do not email flag for this person. |
boolean |
None. |
| DoNotPhone |
Gets or sets the do not phone flag for this person. |
boolean |
None. |
| AlternateID |
Gets or sets the alternate ID for this person. |
string |
None. |
| DateOfBirth |
Gets or sets the date of birth for this person. |
date |
None. |
| Comment |
Gets or sets the comment for this person. |
string |
None. |
| BirthPlace |
Gets or sets the Birthplace for this person. |
string |
None. |
| Occupation |
Gets or sets the occupation for this person. |
string |
None. |
| USCitizen |
Gets or sets a value indicating if this person is a US Citizen |
boolean |
None. |
| Military |
Gets or sets a value indicating if this person is in the Military |
boolean |
None. |
| Active |
Gets or sets the active status for this person. |
integer |
None. |
| MemberComment |
Gets or sets the member comment for this person. |
string |
None. |
| HasMedicare |
Gets or sets the flag to indicate this person has medicare. |
boolean |
None. |
| MedicareID |
Gets or sets the Medicare ID for this person. |
string |
None. |
| MedicarePlan |
Gets or sets the Medicare plan for this person. |
string |
None. |
| MedicareEffectiveDate |
Gets or sets the Medicare effective date for this person. |
date |
None. |
| LocationName |
Gets or sets the location name associated with the member |
string |
None. |
| DependantIndicator |
Gets or sets the indicator tells you whether the member is a dependent (D) or a primary cardholder (P) |
string |
None. |
| CriticalComment |
Gets or sets the critical comment for this Patient. |
string |
None. |
| Identifier |
Gets or sets the custom identifier for this Patient. |
string |
None. |
| Diabetic |
Gets or sets a value indicating if this Patient is diabetic. |
boolean |
None. |
| IsHospice |
Gets or sets a value indicating if this Patient is in hospice. |
boolean |
None. |
| NonCodedAllergies |
Gets or sets this Patients non coded allergies. |
string |
None. |
| SentToPharmacy |
Gets or sets a value indicating if this Patient was send to the pharmacy. |
boolean |
None. |
| CardholderID |
Gets or sets the card holder id for this Patient. |
string |
None. |
| SecondaryCoverageOnly |
Gets or sets a value indicating secondary coverage only for this patient. |
boolean |
None. |
| Locked |
Gets or sets a value indicating if this patient is locked. |
boolean |
None. |
| CoverageLevelCode |
Gets or sets the value associated with the coverage level code. |
CoverageLevelCodes |
None. |
| YearlyHouseholdIncome |
Gets or sets the value associated with the patients yearly household income. |
decimal number |
None. |
| IsMDCaresPatient |
Gets or sets the value indicating if the patient is MD Cares. |
boolean |
None. |
| PersonCode |
Gets or sets the person code value for this patient. |
string |
None. |
| COBRA |
Gets or sets the value indicating if the patient is COBRA. |
boolean |
None. |
| IsTestMember |
Gets or sets the value indicating if this is a test patient. |
boolean |
None. |
| IgnoreMemberInfoInClaims |
Gets or sets the value indicating to ignore member info in claims. (CardHolder Only) |
boolean |
None. |
| SetMemberInfoNextClaim |
Gets or sets the value indicating to set member info in the next claim. (CardHolder Only) |
boolean |
None. |
| RoomNumber |
Gets or sets the room number for this patient. |
string |
None. |
| BedNumber |
Gets or sets the bed number for this patient. |
string |
None. |
| AdmittedDate |
Gets or sets the datetime the patient was admitted. |
date |
None. |
| DischargeDate |
Gets or sets the datetime the patient was discharged. |
date |
None. |
| CardHolderMemberID |
Gets the unique memberID of the cardholder associated with the current member. If this value is equal to the ID of the current member, then this member is the cardholder. |
integer |
None. |
| CurrentPatientPlan |
The CurrentPatientPlan object will contain the details of the current patient plan for the member. If no current plan exists, this object will be null. |
CurrentPatientPlanModel |
None. |
| ClientID | string |
None. |
|
| ExternalID | string |
None. |
|
| CurrentFormulary | MemberFormularyInfoModel |
None. |
|
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
| ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 38",
"id": 39,
"salutation": "sample string 1",
"firstName": "sample string 2",
"middleName": "sample string 3",
"lastName": "sample string 4",
"suffix": "sample string 5",
"emailAddress": "sample string 6",
"gender": "sample string 7",
"heightInches": 1,
"ssn": "sample string 8",
"doNotEmail": true,
"doNotPhone": true,
"alternateID": "sample string 11",
"dateOfBirth": "2025-07-16T15:08:58.5226594-05:00",
"comment": "sample string 13",
"birthPlace": "sample string 14",
"occupation": "sample string 15",
"usCitizen": true,
"military": true,
"active": 16,
"memberComment": "sample string 17",
"hasMedicare": true,
"medicareID": "sample string 19",
"medicarePlan": "sample string 20",
"medicareEffectiveDate": "2025-07-16T15:08:58.5236592-05:00",
"locationName": "sample string 22",
"dependantIndicator": "sample string 23",
"criticalComment": "sample string 24",
"identifier": "sample string 25",
"diabetic": true,
"isHospice": true,
"nonCodedAllergies": "sample string 27",
"sentToPharmacy": true,
"cardholderID": "sample string 28",
"secondaryCoverageOnly": true,
"locked": true,
"coverageLevelCode": "CHD - Children Only",
"yearlyHouseholdIncome": 1.0,
"isMDCaresPatient": true,
"personCode": "sample string 29",
"cobra": true,
"isTestMember": true,
"ignoreMemberInfoInClaims": true,
"setMemberInfoNextClaim": true,
"roomNumber": "sample string 33",
"bedNumber": "sample string 34",
"admittedDate": "2025-07-16T15:08:58.5246595-05:00",
"dischargeDate": "2025-07-16T15:08:58.5246595-05:00",
"cardHolderMemberID": 35,
"currentPatientPlan": {
"planContractNo": 1,
"contractCode": "sample string 1",
"contractName": "sample string 2",
"groupID": 1,
"groupPlanNo": 1,
"planName": "sample string 3",
"facilityARTypeNo": 1,
"arShortCode": "sample string 4",
"effectiveStartDate": "2025-07-16T15:08:58.5246595-05:00",
"effectiveEndDate": "2025-07-16T15:08:58.5246595-05:00"
},
"clientID": "sample string 36",
"externalID": "sample string 37",
"currentFormulary": {
"url": "sample string 2",
"id": 3,
"name": "sample string 1"
}
}