YM REST Services

<back to all web services

InformzBulkUploadForDuesRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permissions:/admin/email/, Informz
The following routes are available for this service:
POST/Ams/{ClientID}/InformzBulkUploadForDuesUpload emails and personal data to Informz for dues.
InformzBulkUploadForDuesRequest Parameters:
NameParameterData TypeRequiredDescription
GroupNamebodystringNo
Statusbodyint?No
datLowerbodystringNo
datUpperbodystringNo
CardFailedbodyboolNo
InvoiceNobodyint?No
PaymentOptionbodyint?No
cdlIDsToExcludebodystringNo
InvoiceURLbodystringNo
datSentMinbodystringNo
datSentMaxbodystringNo
cdlModifierIDsbodystringNo
HasOutstandingBalancebodyint?No
datDueminbodystringNo
datDuemaxbodystringNo
datPaymentAppliedMinbodystringNo
datPaymentAppliedMaxbodystringNo
datPaymentCreatedMinbodystringNo
datPaymentCreatedMaxbodystringNo
OrganizationbodystringNo
InvoicePaymentURLbodystringNo
cdlGroupIDsbodystringNo
InstallmentFilterbodyint?No
cdlMembershipIDsbodystringNo
NamebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/InformzBulkUploadForDues HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupName: String,
	Status: 0,
	datLower: String,
	datUpper: String,
	CardFailed: False,
	InvoiceNo: 0,
	PaymentOption: 0,
	cdlIDsToExclude: String,
	InvoiceURL: String,
	datSentMin: String,
	datSentMax: String,
	cdlModifierIDs: String,
	HasOutstandingBalance: 0,
	datDuemin: String,
	datDuemax: String,
	datPaymentAppliedMin: String,
	datPaymentAppliedMax: String,
	datPaymentCreatedMin: String,
	datPaymentCreatedMax: String,
	Organization: String,
	InvoicePaymentURL: String,
	cdlGroupIDs: String,
	InstallmentFilter: 0,
	cdlMembershipIDs: String,
	Name: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T06:46:44.9263070-04:00,
	ServerID: WS-4-7-585,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T07:01:37.2084240-04:00,
	Device: Desktop
}