ClubManager.Api

<back to all web services

Command.AddProspectCommandRequest

Requires Authentication
The following routes are available for this service:
POST/api/Command/AddProspectCommand
AddProspectResult Parameters:
NameParameterData TypeRequiredDescription
MemberIdformintNo
IsExistingMemberformboolNo
MemberKeyformGuidNo
AppRegistrationIdformstringNo

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 /api/Command/AddProspectCommand HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Gender: Unknown,
	Tags: 
	[
		String
	],
	AgreedToTerms: False,
	IsOnlineJoining: False,
	PhotoPermission: False,
	FirstAidPermission: False,
	GiftAidPermission: False,
	OptInEmail: False,
	OptInSms: False,
	OptInNotification: False,
	OptInPostal: False,
	OptInTelephone: False,
	CustomAttributes: 
	[
		{
			CustomAttributeId: 0,
			CustomAttributeValueId: 0,
			InstanceId: 0,
			StoredValue: String,
			TypeName: String,
			ReadOnly: False
		}
	],
	MemberId: 0,
	Title: String,
	Forenames: String,
	Surname: String,
	CompanyName: String,
	Address1: String,
	Address2: String,
	City: String,
	County: String,
	Country: String,
	Postcode: String,
	DateOfBirth: 0001-01-01,
	EmailAddress: String,
	HomePhone: String,
	MobilePhone: String,
	EmergencyContact: String,
	ParentName: String,
	ParentSurname: String,
	MedicalInformation: String,
	Recaptcha: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberId: 0,
	IsExistingMember: False,
	MemberKey: 00000000000000000000000000000000,
	AppRegistrationId: String
}