branch.schema.md

Branch Schema

https://ns.adobe.com/xdm/classes/fsi/branch

For branch information such as ID, name, and open and close times.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	classes/fsi/branch.schema.json

Schema Hierarchy

• Branch https://ns.adobe.com/xdm/classes/fsi/branch
  • Record Schema https://ns.adobe.com/xdm/data/record
  • Postal address https://ns.adobe.com/xdm/common/address

Branch Example

{}

Branch Properties

Property	Type	Required	Defined by
@id	string	Optional	Record Schema
xdm:branchAddress	Postal address	Optional	Branch (this schema)
xdm:branchCloseTime	string	Optional	Branch (this schema)
xdm:branchID	string	Optional	Branch (this schema)
xdm:branchName	string	Optional	Branch (this schema)
xdm:branchOpenTime	string	Optional	Branch (this schema)
xdm:isBranchActive	boolean	Optional	Branch (this schema)
*	any	Additional	this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

• is optional
• type: string
• defined in Record Schema

@id Type

string

• format: uri-reference – URI Reference (according to RFC3986)

xdm:branchAddress

Branch Address

Physical address where the branch is located.

xdm:branchAddress

• is optional
• type: Postal address
• defined in this schema

xdm:branchAddress Type

• Postal address – https://ns.adobe.com/xdm/common/address

xdm:branchCloseTime

Branch Close Time

Time of day the branch closes.

xdm:branchCloseTime

• is optional
• type: string
• defined in this schema

xdm:branchCloseTime Type

string

• format: date-time – date and time (according to RFC 3339, section 5.6)

xdm:branchID

Branch ID

ID associated with the branch.

xdm:branchID

• is optional
• type: string
• defined in this schema

xdm:branchID Type

string

xdm:branchName

Branch Name

Name of the branch.

xdm:branchName

• is optional
• type: string
• defined in this schema

xdm:branchName Type

string

xdm:branchOpenTime

Brancn Open Time

Time of day the branch opens.

xdm:branchOpenTime

• is optional
• type: string
• defined in this schema

xdm:branchOpenTime Type

string

• format: date-time – date and time (according to RFC 3339, section 5.6)

xdm:isBranchActive

Is Branch Active

Yes/no if the branch is currently active.

xdm:isBranchActive

• is optional
• type: boolean
• defined in this schema

xdm:isBranchActive Type

boolean