PUT api/Membership/MembershipPurchase/{memberNumber}/{giftAid}/{handleRenewals}/{paymentMethod}/{membershipStartDate}

Allows a membership to be purchased or renewed for a customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
memberNumber

The membership number to be renewed or added to.

 integer

Required
giftAid

A flag to indicate if the sale should be gift aided.

 boolean

Required
handleRenewals

A flag to indictae if the request should be handled as a renewal.

 boolean

Required
paymentMethod

The method of payment for the membership purchase.

 string

Required
membershipStartDate

The date on which the membership should be begin, leave blank if it should start straight away.

 date

Required

Body Parameters

The membership purchase object containing the details of the member, products and joints.

APIMembershipPurchase
NameDescriptionTypeAdditional information
Customer

APICustomer

None.
GiftMembership

boolean

None.
GiftPayer

APICustomer

None.
Products

Collection of Object

None.
Joints

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
{"Customer":{"ID":0,"Email":"","UDF":"","Title":"","Firstname":"","Middlename":"","Lastname":"","DOB":"0001-01-01T00:00:00","CompanyName":"","HouseNo":"","AddressLine1":"","AddressLine2":"","AddressLine3":"","City":"","Postcode":"","County":"","Country":"","TelephoneNumber":"","EveningTelephoneNumber":"","MailingList":"","Notes":"","Password":"","Interests":null,"PersonImage":"","DDAcountHolder":"","DDAccountNumber":"","DDSortCode":"","DDBankName":"","DDBankAddress":"","DDBankPostCode":"","MemberNumber":"","AccountRef":"","ConsentMail":false,"ConsentPhone":false,"ConsentSMS":false,"ConsentEmail":false,"Username":"","ForcePasswordChange":false,"CustomerRef":"","CustomerUDFs":null},"GiftMembership":false,"GiftPayer":{"ID":0,"Email":"","UDF":"","Title":"","Firstname":"","Middlename":"","Lastname":"","DOB":"0001-01-01T00:00:00","CompanyName":"","HouseNo":"","AddressLine1":"","AddressLine2":"","AddressLine3":"","City":"","Postcode":"","County":"","Country":"","TelephoneNumber":"","EveningTelephoneNumber":"","MailingList":"","Notes":"","Password":"","Interests":null,"PersonImage":"","DDAcountHolder":"","DDAccountNumber":"","DDSortCode":"","DDBankName":"","DDBankAddress":"","DDBankPostCode":"","MemberNumber":"","AccountRef":"","ConsentMail":false,"ConsentPhone":false,"ConsentSMS":false,"ConsentEmail":false,"Username":"","ForcePasswordChange":false,"CustomerRef":"","CustomerUDFs":null},"Products":[{"ID":0,"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null,"TicketCapacity":0,"TicketAvailability":0,"Barcode":"","Diminishing":true,"Discontinued":false,"InActive":false,"StockInUse":true}],"Joints":[{"ID":0,"MemberNumber":"","Title":"","FirstName":"","LastName":"","PersonRef":"","CreatedOn":"0001-01-01T00:00:00"}]}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<MembershipPurchase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Customer>
    <ID>0</ID>
    <Email />
    <UDF />
    <Title />
    <Firstname />
    <Middlename />
    <Lastname />
    <DOB>0001-01-01T00:00:00</DOB>
    <CompanyName />
    <HouseNo />
    <AddressLine1 />
    <AddressLine2 />
    <AddressLine3 />
    <City />
    <Postcode />
    <County />
    <Country />
    <TelephoneNumber />
    <EveningTelephoneNumber />
    <MailingList />
    <Notes />
    <Password />
    <PersonImage />
    <DDAcountHolder />
    <DDAccountNumber />
    <DDSortCode />
    <DDBankName />
    <DDBankAddress />
    <DDBankPostCode />
    <MemberNumber />
    <AccountRef />
    <ConsentMail>false</ConsentMail>
    <ConsentPhone>false</ConsentPhone>
    <ConsentSMS>false</ConsentSMS>
    <ConsentEmail>false</ConsentEmail>
    <Username />
    <ForcePasswordChange>false</ForcePasswordChange>
    <CustomerRef />
  </Customer>
  <GiftMembership>false</GiftMembership>
  <GiftPayer>
    <ID>0</ID>
    <Email />
    <UDF />
    <Title />
    <Firstname />
    <Middlename />
    <Lastname />
    <DOB>0001-01-01T00:00:00</DOB>
    <CompanyName />
    <HouseNo />
    <AddressLine1 />
    <AddressLine2 />
    <AddressLine3 />
    <City />
    <Postcode />
    <County />
    <Country />
    <TelephoneNumber />
    <EveningTelephoneNumber />
    <MailingList />
    <Notes />
    <Password />
    <PersonImage />
    <DDAcountHolder />
    <DDAccountNumber />
    <DDSortCode />
    <DDBankName />
    <DDBankAddress />
    <DDBankPostCode />
    <MemberNumber />
    <AccountRef />
    <ConsentMail>false</ConsentMail>
    <ConsentPhone>false</ConsentPhone>
    <ConsentSMS>false</ConsentSMS>
    <ConsentEmail>false</ConsentEmail>
    <Username />
    <ForcePasswordChange>false</ForcePasswordChange>
    <CustomerRef />
  </GiftPayer>
  <Products>
    <APIProduct>
      <ID>0</ID>
      <PLU />
      <ProductDescription />
      <TicketDescription />
      <GiftAidProduct>false</GiftAidProduct>
      <GiftAidPortion>0</GiftAidPortion>
      <Adults>0</Adults>
      <Children>0</Children>
      <CategoryCode>0</CategoryCode>
      <CategoryName />
      <SubCategory />
      <Department />
      <PriceDescription />
      <Price>0</Price>
      <OnHand>0</OnHand>
      <ProductImage />
      <Notes />
      <IsKit>false</IsKit>
      <LowestKitItemPLU />
      <Quantity>0</Quantity>
      <SeatReservationID>0</SeatReservationID>
      <GiftVoucherReference />
      <Donation>false</Donation>
      <TicketCapacity>0</TicketCapacity>
      <TicketAvailability>0</TicketAvailability>
      <Barcode />
      <Diminishing>true</Diminishing>
      <Discontinued>false</Discontinued>
      <InActive>false</InActive>
      <StockInUse>true</StockInUse>
    </APIProduct>
  </Products>
  <Joints>
    <APIMembershipJoint>
      <ID>0</ID>
      <MemberNumber />
      <Title />
      <FirstName />
      <LastName />
      <PersonRef />
      <CreatedOn>0001-01-01T00:00:00</CreatedOn>
    </APIMembershipJoint>
  </Joints>
</MembershipPurchase>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"Result":"Success","members":[{"MemberNumber":"","MemberName":"","PersonRef":0,"CreatedOn":"0001-01-01T00:00:00","RenewalDate":"0001-01-01T00:00:00","Description":"","NumberOfJointsAllowed":0,"CurrentNumberOfJoints":0,"Joints":null,"Type":""}],"eTickets":[{"Barcode":"","BookingID":0,"TicketType":"","VisitDate":"0001-01-01T00:00:00"}]}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<MembershipPurchaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>Success</Result>
  <members>
    <APIMembership>
      <MemberNumber />
      <MemberName />
      <PersonRef>0</PersonRef>
      <CreatedOn>0001-01-01T00:00:00</CreatedOn>
      <RenewalDate>0001-01-01T00:00:00</RenewalDate>
      <Description />
      <NumberOfJointsAllowed>0</NumberOfJointsAllowed>
      <CurrentNumberOfJoints>0</CurrentNumberOfJoints>
      <Type />
    </APIMembership>
  </members>
  <eTickets>
    <APIETicket>
      <Barcode />
      <BookingID>0</BookingID>
      <TicketType />
      <VisitDate>0001-01-01T00:00:00</VisitDate>
    </APIETicket>
  </eTickets>
</MembershipPurchaseResponse>