Contents x
    Get service tickets filtered and paged
    • 09 May 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get service tickets filtered and paged

    • Updated on 09 May 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/maintenance/servicetickets/filter

    [PREVIEW] Get a paged list of existing service tickets, optionally filtered to the given parameters.

    Description

    Retrieve a paged list of existing service tickets, optionally filtered to the given parameters. 

    Use Case

    The Bloxs user has an external App connected to Bloxs and wants to display all the service tickets that are currently 'Active' and have the priority 'high'. By entering these two parameters in this endpoint the user can retrieve all service tickets that meets these parameters, and display them in the App.

    Request fields

    The request contains the following fields:

    FieldDescription
    paging.pageSizeThe maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number).
    paging.pageNumberThis allows the requesting party to specify which of the pages they want to receive.
    sorting.columnNameThe data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here.
    sorting.orderBased on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a).
    referenceThe unique identifier for this service ticket within Bloxs. This is unique (per client specific environment) for all service tickets. This identifier is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    reportingDate
    		The date on which the service ticket was created. This value is not automatically generated by the Bloxs system. If this field is left empty, the request will be invalid.
    stateName
    		Name of the current status of the service ticket. Bloxs provides a standard list with options, however the user can modify the list with options in the admin module. In order to retrieve the full list of currently available status names, the following endpoint can be used: GET states.
    priority
    		Priority level of the report. This is based on a fixed list predefined by Bloxs, and cannot be modified by users. Each priority level is linked to reminder settings, which trigger tasks or emails at a defined frequency.
    problemCategoryName
    		Pertains to the problem category to which the service ticket belongs. This is a standard list predefined by Bloxs, that indicates the category of the issue, such as electrical, windows, etc. In order to retrieve the full list of available category names, the following endpoint can be used: GET problem categories.
    realEstateObjectReference
    		This pertains to the reference of the real estate object to which the service ticket applies. Please note, a reference relating to a real estate object must be included here.
    reporterReference

    This reference refers to the person who should be contacted with any communication regarding the service ticket. Please note that a reference of a relation (see relations API) must be included here and the contact has to exist within Bloxs.

    tenantReferenceThe tenant reference. This will automatically be populated based on the date the service ticket was submitted and the registered tenant of the property at that time.
    supplierReference
    		This reference refers to the supplier. Please note that a relation reference (see relations API) must be included here and the supplier has to exist within Bloxs.


    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    filter
    object (ServiceTicketSearchRequestFilter)
    reference
    string | null
    externalIdentifier
    string | null
    reportingDate
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    stateName
    string | null
    priority
    integer (int32)

    1 = Low

    2 = Normal

    3 = High

    Valid values[ \1\, \2\, \3\ ]
    problemCategoryName
    string | null
    realEstateObjectReference
    string | null
    reporterReference
    string | null
    tenantReference
    string | null
    supplierReference
    string | null
    Responses
    200

    OK

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    serviceTickets
    Array of object (ServiceTicketSearchResultFilter) | null
    object
    reference
    string | null
    externalIdentifier
    string | null
    reportingDate
    string (date-time)
    stateName
    string | null
    priority
    integer (int32)

    1 = Low

    2 = Normal

    3 = High

    Valid values[ \1\, \2\, \3\ ]
    problemCategoryName
    string | null
    realEstateObjectReference
    string | null
    reporterReference
    string | null
    tenantReference
    string | null
    supplierReference
    string | null
    What's Next