Member Expose API

Get All Members

This endpoint retrieves all members within access limits of user role.

HTTP Request

GET

/entity/exposed/member

Query Parameters

Parameter

client_id

Type

UUID

Required

Yes

Description

Unique client id for user access verification.

Parameter

building_id

Type

UUID

Required

No

Description

If set, the result will only contain the members of specific building.

Parameter

mailroom_id

Type

UUID

Required

No

Description

If set, the count returned will only contain number of packages in the mailroom against the member

Parameter

business_id

Type

UUID

Required

No

Description

If set, the result will only contain the members of specific business.

Parameter

member_ids

Type

String

Required

No

Description

Should contain comma seperated UUID only. UUIDs of members for which records to show.

Parameter

include_profile_pictures

Type

Boolean

Required

No

Description

Default: false. If true, the member records will have profile pictures (base64 encoded) too.

Parameter

include_num_pending_packages

Type

Boolean

Required

No

Description

Default: false. If true, number of pending packages associated with all the members will also be returned. Please use this cautiously as it can slow down the query processing.

Parameter

include_designated_members_only

Type

Boolean

Required

No

Description

Default: false. If true, only designated members of business will be returned. Only compatible with business_id parameter

Parameter

include_business

Type

Boolean

Required

No

Description

Default: false. if true, the response will contain an array of json business objects

Parameter

pagination_limit

Type

Integer

Required

No

Description

Default/Max:50, if set, the number of records returned will be equal to this number.

Parameter

pagination_offset

Type

Integer

Required

No

Description

if set, the result records would be offset-ed by this number.

Parameter

order_by

Type

Integer

Required

No

Description

Default created_at. One of the “recent_notified_first”, “email”, “phone”, “created_at”. If ‘recent_notified_first’ is specified, then members who have packages will appear at top and will be sorted according to the packages which have been recently notified.

Parameter

order_asc

Type

Integer

Required

No

Description

Default true. if true, the results will be sorted ascending.

Parameter

platform

Type

String

Required

No

Description

Default: “legacy”. One of the specified platforms: “ios”, “dasboard”, “leagcy”.

Parameter

city_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of Cities.

Parameter

state_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of States.

Parameter

country_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of Countries.

Parameter

package_activity_type

Type

String

Required

No

Description

Default:’SCAN-IN’.Value will be One of ‘SCAN-IN’,’SCAN-OUT’,’ALL’, return member packages based on filter.

Response Example

[
  {
    "member_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "name": "",
    "email": "",
    "phone": "",
    "office_number": "",
    "floor": "",
    "permanent_address": "",
    "note": "",
    "building_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "building_name": "",
    "is_hot_desk": false,
    "is_active": true,
    "is_manually_updated": true,
    "is_signed_up": false,
    "alternate_name": [
      "",
      "",
      ""
    ],
    "alternate_email": [
      "",
      "",
      ""
    ],
    "alternate_phone": [
      "",
      "",
      ""
    ],
    "updated_by": "",
    "updated_at": "2018-11-22T11:18:52.000Z",
    "count": "1",
    "profile_picture": "",
    "member_businesses": [
      {
        "name": "",
        "alternate_name": null,
        "business_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
        "is_designated": false
      }
    ]
  }
]

Package Expose API

Get All Packages

Get all packages.

HTTP Request

GET

/entity/exposed/package

Query Parameters

Parameter

client_id

Type

UUID

Required

Yes

Description

Unique client id for user access verification.

Parameter

mailroom_id

Type

String

Required

No

Description

Should contain comma seperated UUID only. UUIDs of mailrooms for which packages to show.

Parameter

building_id

Type

String

Required

No

Description

Should contain comma seperated UUID only. UUIDs of buildings for which packages to show.

Parameter

member_id

Type

String

Required

No

Description

Should contain comma seperated UUID only. UUIDs of members for which packages to show.

Parameter

business_id

Type

String

Required

No

Description

Should contain comma seperated UUID only. UUIDs of businesses for which pack.

Parameter

platform

Type

String

Required

No

Description

Default: “legacy”. One of the specified platforms: “ios”, “dasboard”, “leagcy”.

Parameter

city_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of Cities.

Parameter

state_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of States.

Parameter

country_id

Type

String

Required

No

Description

Should contain comma seperated numbers only. IDs of Countries.

Parameter

include_package_thumbnail

Type

Boolean

Required

No

Description

Default: false. If true, will include package thumbnail in Base64 text.

Parameter

include_image_links

Type

Boolean

Required

No

Description

Default: false. If true, will include package thumbnail URL.

Parameter

include_business_member_packages

Type

Boolean

Required

No

Description

Default: false. If true, will include business member packages.

Parameter

include_member_businesses_images

Type

Boolean

Required

No

Description

Default: false. If true, will return members businesses image.

Parameter

include_member_businesses

Type

Boolean

Required

No

Description

Default: false. If true, will include business of members.

Parameter

graph_type_filter

Type

Boolean

Required

No

Description

Default: false. If true, will return packages based on graph filter dates.

Parameter

from_date

Type

Date

Required

No

Description

Date in iso 8601 format.

Parameter

to_date

Type

Date

Required

No

Description

Date in iso 8601 format.

Parameter

pagination_offset

Type

Integer

Required

No

Description

Default: 0. The pagination offset.

Parameter

pagination_limit

Type

Integer

Required

No

Description

Default/Max: 50. The pagination limit.

Parameter

order_by

Type

String

Required

No

Description

Default: created_at. One of the “created_at”, “updated_at”, “mailroom_name”, “member_name”, “business_name”, “building_name”, “status”.

Parameter

order_asc

Type

String

Required

No

Description

Default: false. true to sort packages in asending order.

Parameter

filter_option

Type

String

Required

No

Description

Should contain comma seperated strings only.One or Multiple the value ‘scanned’, ‘deleted’, collected’, overdue’, ‘outstanding’, ‘discarded’, ‘legacy’.

Parameter

date_filtering

Type

Boolean

Required

No

Description

Default: false. If true, will return packages based on filter dates.

Parameter

tenant

Type

Boolean

Required

No

Description

ID of tenant a user belongs to.

Parameter

filter_type

Type

Boolean

Required

No

Description

Default: SCAN-IN.One of the filter “SCAN_OUT”,”ALL”. returns packages based on filter.

Response Example

[
  {
    "packages_count": "1",
    "package_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "uuid": "",
    "member_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "member_name": "",
    "member_email": "",
    "member_phone": "",
    "member_office": "",
    "is_designated": true,
    "member_businesses": [
      {
        "business_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
        "name": "PackageX",
        "business_image_link": ""
      }
    ],
    "business_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "business_name": "",
    "mailroom_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "mailroom_name": "Mailroom1",
    "building_id": "a45d87a3-80fb-4a5e-84aa-98c265de14c8",
    "building_name": "London",
    "building_country": "EARTH",
    "courier_name": null,
    "tracking_no": null,
    "category": [],
    "package_note": "",
    "package_discard_reason": "",
    "package_picked_reason": "",
    "status": "PICKED",
    "created_at": "2018-11-20T13:23:50.000Z",
    "updated_at": "2018-11-20T13:24:09.000Z",
    "package_thumbnail": ""
  }
]
package tracking application

© 2020 PackageX, Inc. All rights reserved.