API

WFWT_WebsiteAPI V1 - MembershipHeaderPrivate

Resource Details

URL: /WFWT_WebsiteAPI/v1/MembershipHeaderPrivate/{membershipid}
Description: API resource which allows access to view and post new memberships.
Call type: Entity
Filter:
Sort:
GET: Allowed - Requires Authentication
POST: Allowed - Requires Authentication
PUT: Not Allowed
DELETE: Not Allowed

Fields

Field Name Select By Default Filterable Sortable Postable Post Default Value Putable
accountname -
Validation (Rule - Message):
  • Required Field - The account name must be specified
accountnumber -
accountverifiedby -
Validation (Rule - Message):
  • Required Field - This can not be empty if Account Verified is provided
animalid_bsk -
balance -
banddescription -
bandid -
bandname -
Validation (Rule - Message):
  • Must be in the list of values - Invalid entry
bankaddress -
bankname -
bankpostcode -
bic -
Validation (Rule - Message):
  • Must macth the RegEx: ^([A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?)$ - Please enter a valid BIC / Swift Code. It should contain only numbers and upper case letters (no spaces) and be in the form "6 letters + 2 numbers or letters (+ optional: 3 numbers or letters)"
concessioncategory_bsk -
created -
createdby -
currency -
Validation (Rule - Message):
  • The currency must exist again the lookup
ddidatereceived -
Validation (Rule - Message):
  • Must be a date - ddidatereceived must be a valid date of format DD/MM/YYYY
  • Required Field - You must enter the ddidatereceived
ddimethod -
Validation (Rule - Message):
  • Required Field - You must enter the ddimethod
ddistartdate -
Validation (Rule - Message):
  • Must be a date - ddistartdate must be a valid date of format DD/MM/YYYY
ddistatus -
Validation (Rule - Message):
  • Required Field - You must enter the ddistatus
directdebitinstruction -
expirydate -
Validation (Rule - Message):
  • Must be a date - expirydate must be a valid date of format DD/MM/YYYY
  • Required Field - Please enter an Expiry Date or mark the membership as Open Ended
  • Must be greater than or equal to @STARTDATE - Expiry Date must be greater than or equal to Start Date
giftmembership -
ibannumber -
Validation (Rule - Message):
  • Must macth the RegEx: ^[A-Z]{2}[0-9]{2}([A-Z0-9]?){0,30}$ - Please enter a valid IBAN. IBANs should contain only numbers and upper case letters (no spaces) and be in the form "2 letters + 2 numbers + up to 30 numbers or letters"
invoiceaddressline1 -
Validation (Rule - Message):
  • Required Field - You must enter the invoiceaddressline1
invoiceaddressline3 -
invoiceaddressline4 -
invoicecountry -
invoicepostcode -
Validation (Rule - Message):
  • Required Field - You must enter the invoicepostcode
locationofpaperddi -
Validation (Rule - Message):
  • Required Field - You must enter the locationofpaperddi
membershipcardno -
membershipdetailid -
membershipid -
Validation (Rule - Message):
  • Required Field - You must enter the membershipid
membershiptype -
modified -
modifiedby -
nameoncard_bsk -
nextpayment -
Validation (Rule - Message):
  • Must be a date - nextpayment must be a valid date of format DD/MM/YYYY
nextpaymentamount -
Validation (Rule - Message):
  • Must be numeric - nextpaymentamount must be numeric
outstanding -
payerserialnumber -
Validation (Rule - Message):
  • Required Field - You must enter the payerserialnumber
paymentday -
Validation (Rule - Message):
  • Must be numeric - paymentday must be numeric
  • Must be greater than 0
  • Must be less than or equal to 28
  • Required Field - You must enter the paymentday
paymentfrequency -
Validation (Rule - Message):
  • Required Field - You must enter the paymentfrequency
paymenttype -
Validation (Rule - Message):
  • The payment type must be specified against the membership
periodid -
receiptserialnumber -
Validation (Rule - Message):
  • Required Field - You must enter the receiptserialnumber
recruitername_bsk -
recruitmentlocation_bsk -
serialnumber -
Validation (Rule - Message):
  • Required Field - You must enter the serialnumber
sortcode -
sourcecode -
Validation (Rule - Message):
  • Please enter a valid Source Code
startdate -
Validation (Rule - Message):
  • Must be a date - startdate must be a valid date of format DD/MM/YYYY
  • Required Field - You must enter the startdate
typeid -
Validation (Rule - Message):
  • Required Field - You must enter the typeid
year1destinationcode_bsk -