Skip to content
/
Create 'Tenantinformation...

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

Create '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/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 POST \
  https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/ \
  -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 creation

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"
}

Get '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
curl -i -X GET \
  'https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/{pk}/' \
  -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 selection

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"
}

Delete '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
curl -i -X DELETE \
  'https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollection/{pk}/' \
  -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 deletion

Response
No content
© Pigello. All rights reserved.