Get one single Multipass item

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

Returns the multipass with the specified id.

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)	MultiPass id	Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)	Resource id
Name (string)	Resource name
Description (string)	Description of the activity that will be visible to your customers in your store
ActivityIds ()
PrivateLessonIds ()
Price (decimal number)	Price of activity
Passes (integer)
HasUnlimitedPasses (boolean)
IsFamilyPass (boolean)
Status (string)	Object containing the possible status values (case-insensitive).
IsArchived (boolean)	True if resource is archived
EffectiveDate (date)	Date when resource is effective. Format is 9999-12-31
ExpirationDate (date)	Date when resource expires. Format is 9999-12-31
StartTrigger (string)
EndTrigger (string)
ValidityPeriod (MultiPassValidityApiModel)
MembershipRequired (RequiresMembershipApiModel)
NumberSold (integer)

Response Formats

CODE SAMPLE JSON

[
  {
    "Id": 1,
    "Name": "5x ice skating, weekday",
    "Description": "Access to Ice Skating Rink on weekday nights",
    "ActivityIds": [
      1001,
      1002
    ],
    "PrivateLessonIds": null,
    "Price": 25.0,
    "Passes": 5,
    "HasUnlimitedPasses": false,
    "IsFamilyPass": true,
    "Status": "Visible",
    "IsArchived": false,
    "EffectiveDate": null,
    "ExpirationDate": null,
    "StartTrigger": "OnFirstUse",
    "EndTrigger": "AfterSetPeriod",
    "ValidityPeriod": {
      "ValidityAmount": 1,
      "ValidityPeriodType": "Year"
    },
    "MembershipRequired": {
      "MembershipRestrictionType": "AnyRequired",
      "MembershipIds": [
        2020,
        2021,
        2022
      ]
    },
    "NumberSold": 28
  },
  {
    "Id": 1,
    "Name": "5x ice skating, weekday",
    "Description": "Access to Ice Skating Rink on weekday nights",
    "ActivityIds": [
      1001,
      1002
    ],
    "PrivateLessonIds": null,
    "Price": 25.0,
    "Passes": 5,
    "HasUnlimitedPasses": false,
    "IsFamilyPass": true,
    "Status": "Visible",
    "IsArchived": false,
    "EffectiveDate": null,
    "ExpirationDate": null,
    "StartTrigger": "OnFirstUse",
    "EndTrigger": "AfterSetPeriod",
    "ValidityPeriod": {
      "ValidityAmount": 1,
      "ValidityPeriodType": "Year"
    },
    "MembershipRequired": {
      "MembershipRestrictionType": "AnyRequired",
      "MembershipIds": [
        2020,
        2021,
        2022
      ]
    },
    "NumberSold": 28
  }
]