developer portal

Smartphone

Get option lists

Returns a list of all option lists.

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
401Unauthorized
403Forbidden

Update option list

Updates an option list and creates a new menu structure.

Request body

object

FieldTypeRequired
Id(default = null) Only for folders.stringrequired
Name_Nl(default = null)stringoptional
Name_Fr(default = null)stringoptional
Name_En(default = null)stringoptional
Name_Pl(default = null)stringoptional
Type(default = 0) Type of the mobile clocking node (folder or jobnumber).numberoptional
FilterText(default = null) Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.stringoptional
Prefix(default = null) This prefix will automatically be added in front of the jobnumber entered by the user.stringoptional
JobNumber(default = null) Job number used for postcalculation or activity based timeregistrationstringoptional
Regex(default = null) A jobnumber entered by the user will only be accepted if it matches this regex.stringoptional
InputFilter(default = 0) What kind of input is allowed (free input, only numbers, or hexadecimal).numberoptional
InputType(default = 0) What type of input is allowed (scanning, manual entry or both).numberoptional
ClockingType(default = null) Type of the clocking to be generated (see options below).numberoptional
Children(default = null) Only for folders. Children of this mobile clocking node.arrayoptional
PoiGroupIdstringoptional
PoiRequired(default = false)booleanoptional
ValidatePoiCode(default = false)booleanoptional
CostCenterGroupIdstringoptional
CostCenterRequired(default = false)booleanoptional
ValidateCostCenterCode(default = false)booleanoptional
ExternalCode(default = null)stringoptional
ExternalType(default = null)numberoptional
_typeDescriptorstringoptional

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create option list

Creates a new option list.

Request body

object

FieldTypeRequired
Name_Nl(default = null)stringrequired
Name_Fr(default = null)stringoptional
Name_En(default = null)stringoptional
Name_Pl(default = null)stringoptional
_typeDescriptorstringoptional

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get option list

Returns an option list and its menu structure by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
401Unauthorized
403Forbidden

Get multi job lists

Returns a list of all multi job lists.

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
401Unauthorized
403Forbidden

Get multi job list

Returns a multi job list and its menu structure by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  }
]
401Unauthorized
403Forbidden