ClubManager.Api

<back to all web services

Command.AddProspectCommandRequest

Requires Authentication
The following routes are available for this service:
POST/api/Command/AddProspectCommand
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddProspectResult(ICommandResult):
    member_id: Optional[int] = None
    is_existing_member: Optional[bool] = None
    member_key: Optional[str] = None
    app_registration_id: Optional[str] = None

Python Command.AddProspectCommandRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","EmailAddress":"String","HomePhone":"String","MobilePhone":"String","EmergencyContact":"String","ParentName":"String","ParentSurname":"String","MedicalInformation":"String","Recaptcha":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MemberId":0,"IsExistingMember":false,"MemberKey":"00000000000000000000000000000000","AppRegistrationId":"String"}