REST Resource: resources.buildings

منبع: ساختمان

Public API: Resources.buildings

نمایندگی JSON
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
زمینه های
buildingId

string

شناسه منحصر به فرد برای ساختمان حداکثر طول 100 کاراکتر است.

buildingName

string

نام ساختمان همانطور که توسط کاربران در تقویم مشاهده می شود. باید برای مشتری منحصر به فرد باشد. به عنوان مثال، "NYC-CHEL". حداکثر طول 100 کاراکتر است.

description

string

شرح مختصری از ساختمان. مثلاً «بازار چلسی».

coordinates

object ( BuildingCoordinates )

مختصات جغرافیایی مرکز ساختمان که به صورت طول و عرض جغرافیایی در درجه اعشار بیان می شود.

kind

string

نوعی منبع این است.

etags

string

ETag منبع

floorNames[]

string

نام های نمایشی برای تمامی طبقات این ساختمان. انتظار می رود طبقات به ترتیب صعودی از پایین ترین طبقه به بالاترین طبقه طبقه بندی شوند. برای مثال، ["B2"، "B1"، "L"، "1"، "2"، "2M"، "3"، "PH"] باید حداقل یک ورودی داشته باشد.

address

object ( BuildingAddress )

آدرس پستی ساختمان برای جزئیات بیشتر به PostalAddress مراجعه کنید. توجه داشته باشید که فقط یک خط آدرس و کد منطقه مورد نیاز است.

BuildingCoordinates

Public API: Resources.buildings

نمایندگی JSON
{
  "latitude": number,
  "longitude": number
}
زمینه های
latitude

number

عرض جغرافیایی بر حسب درجه اعشار.

longitude

number

طول جغرافیایی بر حسب درجه اعشار.

آدرس ساختمان

Public API: Resources.buildings

نمایندگی JSON
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
زمینه های
regionCode

string

ضروری. کد منطقه CLDR کشور/منطقه آدرس.

languageCode

string

اختیاری. کد زبان BCP-47 محتویات این آدرس (در صورت شناخته شدن).

postalCode

string

اختیاری. کد پستی آدرس

administrativeArea

string

اختیاری. بالاترین بخش اداری که برای آدرس های پستی یک کشور یا منطقه استفاده می شود.

locality

string

اختیاری. عموماً به بخش شهر/شهرک آدرس اشاره دارد. مثال: شهر ایالات متحده، کمون فناوری اطلاعات، شهر پست بریتانیا. در مناطقی از جهان که محلی ها به خوبی تعریف نشده اند یا به خوبی در این ساختار قرار نمی گیرند، محلی را خالی بگذارید و از خطوط آدرس استفاده کنید.

sublocality

string

اختیاری. موقعیت فرعی آدرس

addressLines[]

string

خطوط آدرس بدون ساختار که سطوح پایین یک آدرس را توصیف می کند.

مواد و روش ها

delete

 یک ساختمان را حذف می کند.

get

 یک ساختمان را بازیابی می کند.

insert

 یک ساختمان را وارد می کند.

list

 فهرستی از ساختمان ها را برای یک حساب کاربری بازیابی می کند.

patch

 یک ساختمان را وصله می کند.

update

 یک ساختمان را به روز می کند.