POST api/groups/{groupid}/membersetup
Adds a new member to the group and plan based on the information sent in the posted model
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| groupid | string |
None. |
Body Parameters
The json formatted member setup model object supplied in the request body that is to be added
MemberSetupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| LastName |
Gets or sets the member last name |
string |
None. |
| FirstName |
Gets or sets the member first name |
string |
None. |
| MiddleName |
Gets or sets the member middle name |
string |
None. |
| DateOfBirth |
Gets or sets the member date of birth |
date |
None. |
| SSN |
Gets or sets the member SSN |
string |
None. |
| PersonCode |
Gets or sets the member person code |
string |
None. |
| Gender |
Gets or sets the member gender - Valid values: M, F, O, U |
string |
None. |
| Comment |
Gets or sets the member comment |
string |
None. |
| IsTestMember |
Gets or sets whether the member is classified as a test member |
boolean |
None. |
| CardholderID |
Gets or sets the member's cardholder Id |
string |
None. |
| EffectiveStartDate |
Gets or sets the member's effective start date; If not specified, the member's start date will be current date. |
date |
None. |
| EffectiveEndDate |
Gets or sets the member's effective enddate. |
date |
None. |
| PlanContractARTypeID |
Gets or sets the AR type associated to the member's plan |
integer |
None. |
| CoverageLevelCode |
Gets or sets the member's coverage level code |
string |
None. |
| HomePhone |
Gets or sets the member's home phone number |
string |
None. |
| HomePhoneExt |
Gets or sets the member's home phone number extention |
string |
None. |
| EmailAddress |
Gets or sets the member's email address |
string |
None. |
| HomeAddress1 |
Gets or sets the member's home address line 1 |
string |
None. |
| HomeAddress2 |
Gets or sets the member's home address line 2 |
string |
None. |
| HomeCity |
Gets or sets the member's home address city |
string |
None. |
| HomeState |
Gets or sets the member's home address state |
string |
None. |
| HomeZip |
Gets or sets the member's home address zip code |
string |
None. |
| MailingAddress1 |
Gets or sets the member's mailing address line 1 |
string |
None. |
| MailingAddress2 |
Gets or sets the member's mailing address line 2 |
string |
None. |
| MailingCity |
Gets or sets the member's mailing address city |
string |
None. |
| MailingState |
Gets or sets the member's mailing address state |
string |
None. |
| MailingZip |
Gets or sets the member's mailing address zip code |
string |
None. |
| ClientID | string |
None. |
|
| ExternalID | string |
None. |
|
| AlternateID | string |
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. |
Request Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 28",
"id": 29,
"lastName": "sample string 1",
"firstName": "sample string 2",
"middleName": "sample string 3",
"dateOfBirth": "2025-05-30T20:49:42.6074888-05:00",
"ssn": "sample string 4",
"personCode": "sample string 5",
"gender": "sample string 6",
"comment": "sample string 7",
"isTestMember": true,
"cardholderID": "sample string 9",
"effectiveStartDate": "2025-05-30T20:49:42.6074888-05:00",
"effectiveEndDate": "2025-05-30T20:49:42.6074888-05:00",
"planContractARTypeID": 10,
"coverageLevelCode": "sample string 11",
"homePhone": "sample string 12",
"homePhoneExt": "sample string 13",
"emailAddress": "sample string 14",
"homeAddress1": "sample string 15",
"homeAddress2": "sample string 16",
"homeCity": "sample string 17",
"homeState": "sample string 18",
"homeZip": "sample string 19",
"mailingAddress1": "sample string 20",
"mailingAddress2": "sample string 21",
"mailingCity": "sample string 22",
"mailingState": "sample string 23",
"mailingZip": "sample string 24",
"clientID": "sample string 25",
"externalID": "sample string 26",
"alternateID": "sample string 27"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
If successful, the member setup model will be returned with the ID of the new record populated.
MemberSetupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| LastName |
Gets or sets the member last name |
string |
None. |
| FirstName |
Gets or sets the member first name |
string |
None. |
| MiddleName |
Gets or sets the member middle name |
string |
None. |
| DateOfBirth |
Gets or sets the member date of birth |
date |
None. |
| SSN |
Gets or sets the member SSN |
string |
None. |
| PersonCode |
Gets or sets the member person code |
string |
None. |
| Gender |
Gets or sets the member gender - Valid values: M, F, O, U |
string |
None. |
| Comment |
Gets or sets the member comment |
string |
None. |
| IsTestMember |
Gets or sets whether the member is classified as a test member |
boolean |
None. |
| CardholderID |
Gets or sets the member's cardholder Id |
string |
None. |
| EffectiveStartDate |
Gets or sets the member's effective start date; If not specified, the member's start date will be current date. |
date |
None. |
| EffectiveEndDate |
Gets or sets the member's effective enddate. |
date |
None. |
| PlanContractARTypeID |
Gets or sets the AR type associated to the member's plan |
integer |
None. |
| CoverageLevelCode |
Gets or sets the member's coverage level code |
string |
None. |
| HomePhone |
Gets or sets the member's home phone number |
string |
None. |
| HomePhoneExt |
Gets or sets the member's home phone number extention |
string |
None. |
| EmailAddress |
Gets or sets the member's email address |
string |
None. |
| HomeAddress1 |
Gets or sets the member's home address line 1 |
string |
None. |
| HomeAddress2 |
Gets or sets the member's home address line 2 |
string |
None. |
| HomeCity |
Gets or sets the member's home address city |
string |
None. |
| HomeState |
Gets or sets the member's home address state |
string |
None. |
| HomeZip |
Gets or sets the member's home address zip code |
string |
None. |
| MailingAddress1 |
Gets or sets the member's mailing address line 1 |
string |
None. |
| MailingAddress2 |
Gets or sets the member's mailing address line 2 |
string |
None. |
| MailingCity |
Gets or sets the member's mailing address city |
string |
None. |
| MailingState |
Gets or sets the member's mailing address state |
string |
None. |
| MailingZip |
Gets or sets the member's mailing address zip code |
string |
None. |
| ClientID | string |
None. |
|
| ExternalID | string |
None. |
|
| AlternateID | string |
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 28",
"id": 29,
"lastName": "sample string 1",
"firstName": "sample string 2",
"middleName": "sample string 3",
"dateOfBirth": "2025-05-30T20:49:42.608486-05:00",
"ssn": "sample string 4",
"personCode": "sample string 5",
"gender": "sample string 6",
"comment": "sample string 7",
"isTestMember": true,
"cardholderID": "sample string 9",
"effectiveStartDate": "2025-05-30T20:49:42.608486-05:00",
"effectiveEndDate": "2025-05-30T20:49:42.608486-05:00",
"planContractARTypeID": 10,
"coverageLevelCode": "sample string 11",
"homePhone": "sample string 12",
"homePhoneExt": "sample string 13",
"emailAddress": "sample string 14",
"homeAddress1": "sample string 15",
"homeAddress2": "sample string 16",
"homeCity": "sample string 17",
"homeState": "sample string 18",
"homeZip": "sample string 19",
"mailingAddress1": "sample string 20",
"mailingAddress2": "sample string 21",
"mailingCity": "sample string 22",
"mailingState": "sample string 23",
"mailingZip": "sample string 24",
"clientID": "sample string 25",
"externalID": "sample string 26",
"alternateID": "sample string 27"
}