Resources

Get all resources

Returns all resources of an enterprise associated with the connector integration. Note that when any of the extents is set to true, the response contains the entities that are associated to a resource. If the extent is not associated to a resource (e.g. resource category not assigned to any resource), this information is not returned. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/resources/getAll

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "4d0201db-36f5-428b-8d11-4f0a65e960cc"
    ],
    "ResourceIds": [
        "5ee074b1-6c86-48e8-915f-c7aa4702086f",
        "c32386aa-1cd2-414a-a823-489325842fbe"
    ],
    "CreatedUtc": {
        "StartUtc": "2022-10-15T00:00:00Z",
        "EndUtc": "2022-10-20T00:00:00Z"
    },
    "UpdatedUtc": {
        "StartUtc": "2022-10-15T00:00:00Z",
        "EndUtc": "2022-10-20T00:00:00Z"
    },
    "Extent": {
        "Resources": true,
        "ResourceCategories": false,
        "ResourceCategoryAssignments": false,
        "ResourceCategoryImageAssignments": false,
        "ResourceFeatures": false,
        "ResourceFeatureAssignments": false,
        "Inactive": false
    },
    "Limitation": { "Count": 10 }
}

Resource extent

Response

{
    "Resources": [
        {
            "Id": "5ee074b1-6c86-48e8-915f-c7aa4702086f",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsActive": true,
            "Name": "101",
            "ParentResourceId": null,
            "State": "Dirty",
            "Descriptions": {},
            "Data": {
                "Discriminator": "Space",
                "Value": {
                    "FloorNumber": "3",
                    "LocationNotes": "A1"
                }
            },
            "CreatedUtc": "2016-03-29T15:14:06Z",
            "UpdatedUtc": "2016-03-29T15:14:06Z"
        },
        {
            "Id": "c32386aa-1cd2-414a-a823-489325842fbe",
            "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
            "IsActive": true,
            "Name": "102",
            "ParentResourceId": null,
            "State": "Inspected",
            "Descriptions": {
                "en-US": "Resource description"
            },
            "Data": {
                "Discriminator": "Space",
                "Value": {
                    "FloorNumber": "3",
                    "LocationNotes": "B2"
                }
            },
            "CreatedUtc": "2016-03-29T15:14:06Z",
            "UpdatedUtc": "2016-03-29T15:14:06Z"
        }
    ],
    "ResourceCategories": [
        "Id": "aaed6e21-1c1f-4644-9872-e53f96a21bf9",
        "ServiceId": "24e2ead5-65a8-4ed9-8286-abdb00f08a1f",
        "IsActive": true,
        "Names": {
            "en-US": "Best Room"
        }
        "ShortNames":{
            "en-US": "BR"
        },
        "Descriptions": {},
        "Ordering": 0,
        "Capacity": 2,
        "ExtraCapacity": 0,
        "ExternalIdentifier": "RT001-BestRoom"
    ],
    "ResourceCategoryAssignments": [
        {
            "Id": "032298ad-b1b8-4936-9420-415a2152304a",
            "IsActive": true,
            "ResourceId": "5ee074b1-6c86-48e8-915f-c7aa4702086f",
            "CategoryId": "aaed6e21-1c1f-4644-9872-e53f96a21bf9",
            "CreatedUtc": "2016-03-29T15:14:06Z",
            "UpdatedUtc": "2016-03-29T15:14:06Z"
        }
    ],
    "ResourceCategoryImageAssignments": [
        {
            "Id": "f3475243-5962-4fb5-bdfd-958f9c65520e",
            "IsActive": true,
            "CategoryId": "aaed6e21-1c1f-4644-9872-e53f96a21bf9",
            "ImageId": "8cd435e0-f024-44a0-84fd-abe300b8ae1c",
            "CreatedUtc": "2016-03-29T15:14:06Z",
            "UpdatedUtc": "2016-03-29T15:14:06Z"
        }
    ],
    "ResourceFeatures": [
        {
            "Id": "a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0",
            "ServiceId": "24e2ead5-65a8-4ed9-8286-abdb00f08a1f",
            "IsActive": true,
            "Classification": "AccessibleBathroom",
            "Names": {
                "en-US": "Accessible Bathroom"
            },
            "ShortNames": {
                "en-US": "AccessBath"
            },
            "Descriptions": {}
        }
    ],
    "ResourceFeatureAssignments": [
        {
            "Id": "ca2b5bf9-24f5-4faa-95ef-b65d38598b08",
            "IsActive": true,
            "ResourceId": "18019693-c66f-4be8-a893-c3d89fd291cc",
            "FeatureId": "a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0",
            "CreatedUtc": "2016-03-29T15:14:06Z",
            "UpdatedUtc": "2016-03-29T15:14:06Z"
        }
    ],
    "Cursor": "c32386aa-1cd2-414a-a823-489325842fbe"
}

Resource

Resource state

  • Dirty

  • Clean

  • Inspected

  • OutOfService

  • OutOfOrder

Resource data

Resource data discriminator

  • Space

  • Object

  • Person

Space resource data

Object resource data

Person resource data

Resource category

Resource category type

  • Room

  • Dorm

  • Bed

  • ...

Update resources

Updates details of the resources.

Request

[PlatformAddress]/api/connector/v1/resources/update

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ResourceUpdates": [
        {
            "ResourceId": "5ee074b1-6c86-48e8-915f-c7aa4702086f",
            "Name": {
                "Value": "0101"
            },
            "ParentResourceId": null,
            "Data": 
            {
                "Discriminator": "Space",
                "Value": {
                    "FloorNumber": {
                        "Value": "1"
                    },
                    "LocationNotes": {
                        "Value": "A1"
                    }
                }
            },
            "State": {
                "Value": "Clean"
            },
            "StateReason": {
                "Value": "Sample reason"
            }
        }
    ]
}

Resource update

Resource data update

Space resource data update

Response

{}

Last updated