Relesys API Docs

v1.2

https://api.relesysapp.net/api/v1.2

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Score Categories

List
GET /serviceformModules/{moduleId}/forms/{formId}/scoreCategories 
https://api.relesysapp.net/api/v1.2/serviceformModules/{moduleId}/forms/{formId}/scoreCategories
Get a list of score categories for the form with ID formId.
Default sort is by sortOrder in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
moduleId string / guid required
formId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
importanceWeight double Filterable Sortable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"29fe8502-531b-4a34-8804-3c12d53219ea","url":null,"importanceWeight":1.0,"creationDateTime":"2024-04-27T10:06:41.4900576+00:00","lastModifiedDateTime":"2024-04-28T10:06:41.4900576+00:00","sortOrder":1,"locales":[{"culture":"en-GB","title":"Score category title example 1"},{"culture":"da-DK","title":"Score category title example 2"}]},{"id":"4c31f019-0ed9-411b-9e8d-3c34c06f2df5","url":null,"importanceWeight":2.0,"creationDateTime":"2024-04-27T10:06:41.4900576+00:00","lastModifiedDateTime":null,"sortOrder":2,"locales":[{"culture":"en-GB","title":"Score category title example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   importanceWeight double      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   sortOrder integer      
   url string      
  nextUrl string      
  previousUrl string