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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<Command.AddProspectCommandRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <AgreedToTerms>false</AgreedToTerms>
  <City>String</City>
  <CompanyName>String</CompanyName>
  <Country>String</Country>
  <County>String</County>
  <CustomAttributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.CustomAttribute">
    <d2p1:CustomAttributeValue>
      <d2p1:CustomAttributeId>0</d2p1:CustomAttributeId>
      <d2p1:CustomAttributeValueId>0</d2p1:CustomAttributeValueId>
      <d2p1:InstanceId>0</d2p1:InstanceId>
      <d2p1:ReadOnly>false</d2p1:ReadOnly>
      <d2p1:StoredValue>String</d2p1:StoredValue>
      <d2p1:TypeName>String</d2p1:TypeName>
    </d2p1:CustomAttributeValue>
  </CustomAttributes>
  <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
  <EmailAddress>String</EmailAddress>
  <EmergencyContact>String</EmergencyContact>
  <FirstAidPermission>false</FirstAidPermission>
  <Forenames>String</Forenames>
  <Gender>Unknown</Gender>
  <GiftAidPermission>false</GiftAidPermission>
  <HomePhone>String</HomePhone>
  <IsOnlineJoining>false</IsOnlineJoining>
  <MedicalInformation>String</MedicalInformation>
  <MemberId>0</MemberId>
  <MobilePhone>String</MobilePhone>
  <OptInEmail>false</OptInEmail>
  <OptInNotification>false</OptInNotification>
  <OptInPostal>false</OptInPostal>
  <OptInSms>false</OptInSms>
  <OptInTelephone>false</OptInTelephone>
  <ParentName>String</ParentName>
  <ParentSurname>String</ParentSurname>
  <PhotoPermission>false</PhotoPermission>
  <Postcode>String</Postcode>
  <Recaptcha>String</Recaptcha>
  <Surname>String</Surname>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Tags>
  <Title>String</Title>
</Command.AddProspectCommandRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddProspectResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Commands.Member">
  <AppRegistrationId>String</AppRegistrationId>
  <IsExistingMember>false</IsExistingMember>
  <MemberId>0</MemberId>
  <MemberKey>00000000-0000-0000-0000-000000000000</MemberKey>
</AddProspectResult>