Back to endpoints

Get the access scans for a location for a specified date range

GET api/V3/{language}/org/{orgIdentifier}/accessmanagement/location/{id}/AccessScans

?start={start}

&end={end}

&page={page}

&perPage={perPage}

This endpoint is paginated.

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)

Id of the item before the /{id} in the url

Required
start (date)

Inclusive start limit of a date range filter. Format is YYYY-MM-DD. When both start and end are omitted, returns events for today

Optional
end (date)

Inclusive end limit of a date range filter. Format is YYYY-MM-DD. If end is omitted, retrieves only for one day specified by start

Optional
page (integer)

Result page number that appears first.

Default value is 1

Optional
perPage (integer)

Number of results per page.

Default value is 200

Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

ConfigurationId (integer)
Status (string)

Object containing the possible status values (case-insensitive).

ScanDate (date)
Warning (string)
WarningMessage (string)
AccessControlType (AccessControlType)
ResponsibleGenuinePersonId (integer)
ResponsibleName (string)
Note (string)

Additional important information, such as what to bring

PersonId (integer)

Id of the person

GenuinePersonId (integer)
MemberNumber (string)
PersonName (string)
Gender (string)

Object containing the gender values NotSpecified, Male, Female and PreferNotToSay

AccountId (integer)

Id of the account

BalanceAtScan (decimal number)
ActivitySegmentId (integer)
ActivityId (integer)

Id of the activity

ActivityName (string)

Part of the hierarchy Program > Category > Subcategory > Activity

SubscriptionState (string)
SubscriptionExpiration (date)
MembershipId (integer)
MembershipName (string)
Location (GenericApiIdObjectV3)

Object containing location id and name

Response Formats

CODE SAMPLE JSON
[
  {
    "Id": 1,
    "ConfigurationId": 1,
    "Status": "string 2",
    "ScanDate": "2022-08-13T00:00:00",
    "Warning": "string 3",
    "WarningMessage": "string 4",
    "AccessControlType": 0,
    "ResponsibleGenuinePersonId": 1,
    "ResponsibleName": "string 5",
    "Note": "string 6",
    "PersonId": 7,
    "GenuinePersonId": 8,
    "MemberNumber": "string 9",
    "PersonName": "string 10",
    "Gender": "string 11",
    "AccountId": 12,
    "BalanceAtScan": 13.0,
    "ActivitySegmentId": 1,
    "ActivityId": 1,
    "ActivityName": "string 14",
    "SubscriptionState": "string 15",
    "SubscriptionExpiration": "2022-08-13",
    "MembershipId": 1,
    "MembershipName": "string 16",
    "Location": {
      "Id": 1
    }
  },
  {
    "Id": 1,
    "ConfigurationId": 1,
    "Status": "string 2",
    "ScanDate": "2022-08-13T00:00:00",
    "Warning": "string 3",
    "WarningMessage": "string 4",
    "AccessControlType": 0,
    "ResponsibleGenuinePersonId": 1,
    "ResponsibleName": "string 5",
    "Note": "string 6",
    "PersonId": 7,
    "GenuinePersonId": 8,
    "MemberNumber": "string 9",
    "PersonName": "string 10",
    "Gender": "string 11",
    "AccountId": 12,
    "BalanceAtScan": 13.0,
    "ActivitySegmentId": 1,
    "ActivityId": 1,
    "ActivityName": "string 14",
    "SubscriptionState": "string 15",
    "SubscriptionExpiration": "2022-08-13",
    "MembershipId": 1,
    "MembershipName": "string 16",
    "Location": {
      "Id": 1
    }
  }
]