| POST | /members |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Members | body | List<Member> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassName | form | string | No | |
| UniqueId | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| ClientId | form | int | No | |
| GroupId | form | string | No | |
| UserId | form | string | No | |
| AlternateUserId | form | string | No | |
| BhUserId | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| MiddleName | form | string | No | |
| PreferredEmailAddress | form | string | No | |
| OtherEmailAddress | form | string | No | |
| PreferredPhoneNumber | form | string | No | |
| PreferredAddress1 | form | string | No | |
| PreferredAddress2 | form | string | No | |
| PreferredCity | form | string | No | |
| PreferredState | form | string | No | |
| PreferredZip | form | string | No | |
| PreferredCountry | form | string | No | |
| AccessLevel | form | string | No | |
| MemberStatus | form | string | No | |
| MemberTypeClient | form | string | No | |
| BillingType | form | string | No | |
| FiscalYear | form | int | No | |
| WorkLocation | form | string | No | |
| DOB | form | DateTime | No | |
| Paperless | form | string | No | |
| DisplayName | form | string | No | |
| DisableLogin | form | string | No | |
| RecurringInvoiceSettings | form | RecurringInvoiceSettings | No | |
| FormFields | form | List<SubscriberFormField> | No | |
| Attributes | form | List<AttributeItem> | No | |
| GroupList | form | List<Chapter> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DonationAmount | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberReply | form | List<MemberReply> | No | |
| IsError | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassName | form | string | No | |
| UniqueId | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| ClientId | form | int | No | |
| ErrorCode | form | int | No | |
| ErrorMessage | form | string | No | |
| BillhighwayuserId | form | int | No | |
| UserId | form | string | No | |
| GroupId | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /members HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Members:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
GroupId: String,
UserId: String,
AlternateUserId: String,
BhUserId: 0,
FirstName: String,
LastName: String,
MiddleName: String,
PreferredEmailAddress: String,
OtherEmailAddress: String,
PreferredPhoneNumber: String,
PreferredAddress1: String,
PreferredAddress2: String,
PreferredCity: String,
PreferredState: String,
PreferredZip: String,
PreferredCountry: String,
AccessLevel: String,
MemberStatus: String,
MemberTypeClient: String,
BillingType: String,
FiscalYear: 0,
WorkLocation: String,
DOB: 0001-01-01,
Paperless: String,
DisplayName: String,
DisableLogin: String,
RecurringInvoiceSettings:
{
DonationAmount: String
},
FormFields:
[
{
Name: String,
Value: String
}
],
Attributes:
[
{
Name: String,
Value: String
}
],
GroupList:
[
{
GroupId: String
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
MemberReply:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
ErrorCode: 0,
ErrorMessage: String,
BillhighwayuserId: 0,
UserId: String,
GroupId: String
}
],
IsError: False
}