Property and Facility Attributes

Attributes are the specifications that determine the actions or tasks a Property or a Facility can perform. The Facility APIs provide a standard set of system-defined Attributes for a Property and a Facility. In addition, you can create custom attributes for your use case.

Property Attributes

The following list describes the predefined Property Attributes that are unique to defining a physical location:

Attribute

Data type

Descriptions

propertyName

string

Name of the participant Property. Character length: 1-64.

propertyCode

string

Any unique associated with the participant Property being created. Character length 1-64.

propertyOwnerId

string

The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.

area

number

Area of the Property.

buildingNumber

string

Building number in which the apartment is.

addressLine1

string

Address line 1.

addressLine2 (optional)

string

Optional address line 2.

addressLine3 (optional)

string

Optional address line 3.

apartmentNumber (optional)

string

Apartment number.

floor (optional)

string

Floor on which the apartment is.

city

string

City of the Property.

state

string

State of the Property.

zipCode

string

Zip code of the Property.

country

object

Country of the Property.

latitude

string

Latitude of the Property.

longitude

string

Longitude of the Property.

Facility Attributes

The following list describes the predefined Facility Attributes that are unique to defining an operating entity:

Attribute

Data type

Description

facilityName

string

Name of the participant Facility. Character length: 1-64.

facilityCode

string

Any unique ID associated with the participant Facility being created. Character length: 1-64.

facilityOwnerId

string

The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.

facilityType

string

Type of Facility.

propertyId

string

ID if the Property to which this Facility belongs.

area

number

Area of the Facility.

operatingHours (optional)

string

Hours of operation of the Facility. (hh:mm:ss to hh:mm:ss)

operatingDays (optional)

string

Days of operation of the Facility. (days of the week/dates in a month)

numberOfDock (optional)

string

Number of docks in a Facility.

Creating Custom Attributes

You can use the Participant Management API to create Custom Attributes for both Property and Facility. To create a Custom Attribute, call the POST /{resourceName}/attributes endpoint and pass the following parameters in the request body:

member

Description

Remarks

name

Name of the attribute to be created.

Data type: string
minLength: 1 maxLength: 32
pattern: It should match a through z or A through Z, inclusive (range)

description (optional)

Description of the attribute.

Data type: string
minLength: 0 maxLength: 256

dataType

Data type of the attribute.

Data type: string

defaultValue (optional)

The default value of the attribute.

Data type: string/boolean/int

validation: range (optional)

Minimum and maximum values if the data type is a number or string.

Data type: object

validation: regex (optional)

Regex pattern that the string type data should match.

Data type: string
minLength: 1 maxLength: 512

validation: valueOneOf (optional)

Enum of accepted values.

Data type: Enum
minItems: 1

validation: required (optional)

Specifies whether the value is required or optional.

Data type: boolean
default: false

mapping (optional)

Mapping with the participant service.

Data type: string

vaultName (optional)

Name of the vault for PII sensitive data.

Data type: string

piiSensitive (optional)

Define if the attribute is PII-Sensitive data.

Data type: boolean
default: false

The following example request body shows how to create and update a Custom Attribute named Scan:

{
  "name": "Scan",
  "description": "Scan capability",
  "dataType": "boolean",
  "indexed": false,
  "defaultValue": true,
  "validation": {
    "range": {
      "min": 0,
      "max": 1000
    },
    "regex": "/^(0?[1-9]|1[0-2]):[0-5][0-9]$/",
    "valueOneOf": [
      [
        "Pickup center",
        "Sortation center",
        "Delivery center",
        "Hub"
      ]
    ],
    "required": false
  },
  "mapping": "properties",
  "vaultName": "vault01",
  "piiSensitive": true,
}
{
  "name": "Scan",
  "description": "Scanning capability",
  "dataType": "boolean",
  "indexed": false,
  "defaultValue": true,
  "validation": {
    "range": {
      "min": 0,
      "max": 1000
    },
    "regex": "/^(0?[1-9]|1[0-2]):[0-5][0-9]$/",
    "valueOneOf": [
      [
        "Pickup center",
        "Sortation center",
        "Hub"
      ]
    ],
    "required": false
  },
  "vaultName": "vault01",
  "piiSensitive": true,
}

Did this page help you?