Skip to content
/
Bulk write 'Tenantinforma...

Communication (2.0.0)

The 'Communication' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Tenantinformationcollectionfile

Operations

Faqentry

Operations

Tenantinformationcollection

Operations

Update 'Tenantinformationcollection'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
titlestring<= 255 charactersrequired
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, building, realestate, community

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, realestate, community

custom_idstring or null<= 128 characters
realestateobject or null(Realestate)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, community

communityobject or null(Community)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, realestate

descriptionstring or null
show_to_corporate_customersboolean
priority_render_within_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: category

organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: priority_render_within_days

Enum12
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
show_to_private_customersboolean
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area, building, realestate, community

curl -i -X PATCH \
  'https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "outdoor_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "building": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "realestate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "community": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "description": "string",
    "show_to_corporate_customers": true,
    "priority_render_within_days": -2147483648,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "category": 1,
    "display_priority": -2147483648,
    "show_to_private_customers": true,
    "parking_lot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "title": "string"
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, building, realestate, community

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, realestate, community

custom_idstring or null<= 128 characters
realestateobject or null(Realestate)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, community

communityobject or null(Community)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, realestate

descriptionstring or null
show_to_corporate_customersboolean
priority_render_within_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: category

organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: priority_render_within_days

Enum12
created_atstring(date-time)read-only
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
show_to_private_customersboolean
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area, building, realestate, community

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "outdoor_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "realestate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "community": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "description": "string",
  "show_to_corporate_customers": true,
  "priority_render_within_days": -2147483648,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "category": 1,
  "created_at": "2019-08-24T14:15:22Z",
  "display_priority": -2147483648,
  "show_to_private_customers": true,
  "parking_lot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string"
}

Bulk write 'Tenantinformationcollection'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
titlestring<= 255 charactersrequired
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, building, realestate, community

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, realestate, community

custom_idstring or null<= 128 characters
realestateobject or null(Realestate)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, community

communityobject or null(Community)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, realestate

descriptionstring or null
show_to_corporate_customersboolean
priority_render_within_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: category

organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: priority_render_within_days

Enum12
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
show_to_private_customersboolean
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area, building, realestate, community

]
curl -i -X POST \
  https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "outdoor_area": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "building": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "realestate": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "community": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "description": "string",
      "show_to_corporate_customers": true,
      "priority_render_within_days": -2147483648,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "category": 1,
      "display_priority": -2147483648,
      "show_to_private_customers": true,
      "parking_lot": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "title": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, building, realestate, community

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, realestate, community

custom_idstring or null<= 128 characters
realestateobject or null(Realestate)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, community

communityobject or null(Community)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, realestate

descriptionstring or null
show_to_corporate_customersboolean
priority_render_within_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: category

organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: priority_render_within_days

Enum12
created_atstring(date-time)read-only
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
show_to_private_customersboolean
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area, building, realestate, community

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "outdoor_area": { … },
    "building": { … },
    "custom_id": "string",
    "realestate": { … },
    "community": { … },
    "description": "string",
    "show_to_corporate_customers": true,
    "priority_render_within_days": -2147483648,
    "organization": { … },
    "category": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "display_priority": -2147483648,
    "show_to_private_customers": true,
    "parking_lot": { … },
    "title": "string"
  }
]

List 'Tenantinformationcollection'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
global_realestatesArray of objects
global_segmentsArray of objects
buildingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

categoryany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

communityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

descriptionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

display_priorityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

outdoor_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

parking_lotany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

priority_render_within_daysany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

realestateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

show_to_corporate_customersany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

show_to_private_customersany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

titleany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, building, realestate, community

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, realestate, community

custom_idstring or null<= 128 characters
realestateobject or null(Realestate)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, community

communityobject or null(Community)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area, building, realestate

descriptionstring or null
show_to_corporate_customersboolean
priority_render_within_daysinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: category

organizationobject or null(Organization)
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: priority_render_within_days

Enum12
created_atstring(date-time)read-only
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
show_to_private_customersboolean
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: outdoor_area, building, realestate, community

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "outdoor_area": { … },
    "building": { … },
    "custom_id": "string",
    "realestate": { … },
    "community": { … },
    "description": "string",
    "show_to_corporate_customers": true,
    "priority_render_within_days": -2147483648,
    "organization": { … },
    "category": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "display_priority": -2147483648,
    "show_to_private_customers": true,
    "parking_lot": { … },
    "title": "string"
  }
]
© Pigello. All rights reserved.