Back to endpoints

Get a membership for an organization

GET api/V3/{language}/org/{orgIdentifier}/memberships/{id}

You can get the membership id from /org/{orgIdentifier}/memberships

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
id (integer)

Membership id

Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

OrganizationId (integer)

Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters

Name (string)

Resource name

Description (string)

Description of the activity that will be visible to your customers in your store

Price (decimal number)

Price of activity

Position (integer)

Display position in the back office and the store. You can set it in admin mode (back office) where it is in the Membership area in the left column

IsArchived (boolean)

True if resource is archived

IsVisible (boolean)

True when program is visible on Amilia pages

DateCreated (date)

Format is 9999-12-31

MembershipType (MembershipTypeV3)

Object containing the possible membership types, which are IndividualPerson, Corporate and Subscription

LedgerCode (LedgerCodeSummaryApiModelV3)

Object containing the id and name of a ledger code. A ledger code is a numeric code that is assigned to an item, an activity or a product in its online store

Tags ()

Object containing the id and name of a tag. Tags are used to group and retrieve activities, such as 'morning' or 'George Smith'

IndividualMembership (IndividualMembershipApiModelV3)

Object containing the details of an individual membership (age restriction, skills restriction, gender restriction, fixed dates, fixed duration, merchandise and replacement details)

CorporateMembership (CorporateMembershipApiModelV3)

Object containing the details of a corporate membership (fixed dates, fixed duration, merchandise and replacement details)

Response Formats

CODE SAMPLE JSON
{
  "Id": 0,
  "OrganizationId": 0,
  "Name": "Early bird membership",
  "Description": "From 6AM to 9AM",
  "Price": 0.0,
  "Position": 0,
  "IsArchived": false,
  "IsVisible": false,
  "DateCreated": "0001-01-01",
  "MembershipType": "IndividualPerson",
  "LedgerCode": {
    "Id": 31,
    "Name": "Summer2019"
  },
  "Tags": [
    {
      "Id": 4,
      "Name": "VIP"
    },
    {
      "Id": 5,
      "Name": "Summer 2019"
    }
  ],
  "IndividualMembership": {
    "AgeRestriction": {
      "Age": {
        "AgeMin": 11,
        "AgeMax": 99,
        "IsAgeInMonths": false
      },
      "AgeRestrictionInDateOf": "2022-08-13"
    },
    "SkillsRestriction": {
      "Skills": [
        {
          "Id": 1,
          "Name": "Swimming"
        },
        {
          "Id": 2,
          "Name": "Rowing"
        }
      ],
      "Age": {
        "AgeMin": 11,
        "AgeMax": 99,
        "IsAgeInMonths": false
      },
      "SkillRestrictionType": "Survival around water"
    },
    "GenderRestriction": [
      "Female"
    ],
    "FixedDates": {
      "EffectiveDate": "2022-08-13",
      "ExpirationDate": "2022-08-13",
      "SalesDate": "2022-08-13"
    },
    "FixedDuration": {
      "Duration": 8,
      "RecurrenceUnitType": "week",
      "RenewInterval": 8,
      "RenewIntervalUnitType": "week"
    },
    "Merchandise": [
      {
        "Id": 8,
        "Name": "Floating device"
      }
    ],
    "ReplacementStatus": "Disabled",
    "ReplacementConstraints": [
      {
        "Id": 9,
        "Name": "Must be used within the year"
      }
    ]
  },
  "CorporateMembership": {
    "FixedDates": {
      "EffectiveDate": "2022-08-13",
      "ExpirationDate": "2022-08-13",
      "SalesDate": "2022-08-13"
    },
    "FixedDuration": {
      "Duration": 8,
      "RecurrenceUnitType": "week",
      "RenewInterval": 8,
      "RenewIntervalUnitType": "week"
    },
    "Merchandise": [
      {
        "Id": 8,
        "Name": "Floating device"
      }
    ],
    "ReplacementStatus": "EnabledWithRestrictions",
    "ReplacementConstraints": [
      {
        "Id": 11,
        "Name": "Must be used within one year"
      }
    ]
  }
}