API

WebsiteAPI V1 - MembershipHeaderPublic

Resource Details

URL: /WebsiteAPI/v1/MembershipHeaderPublic/{membershipid}
Description: API resource which allows access to post new memberships.
Call type: Entity
Filter:
Sort:
GET: Not Allowed
POST: Allowed - Doesn't Require 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 -
accountverified -
Validation (Rule - Message):
  • Must be a date - accountverified must be a valid date of format DD/MM/YYYY
  • Required Field - This can not be empty if Account Verified By is provided
accountVerifiedBy -
Validation (Rule - Message):
  • Required Field - This can not be empty if Account Verified is provided
balance -
banddescription -
bandID -
bandname -
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)"
created -
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
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 -
membershiptype -
modified -
nextPayment -
nextPaymentAmount -
outstanding -
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
paymentStartDate -
Validation (Rule - Message):
  • Must be a date - paymentStartDate must be a valid date of format DD/MM/YYYY
  • Required Field - You must enter the paymentStartDate
paymentType -
Validation (Rule - Message):
  • The payment type must be specified against the membership
periodID -
serialNumber -
Validation (Rule - Message):
  • Required Field - You must enter the serialNumber
sortCode -
sourceCode -
Validation (Rule - Message):
  • Please enter a valid Source Code
startdate -
typeID -
Validation (Rule - Message):
  • Required Field - You must enter the typeID