Usage

Represents a job in Goana. There are 2 versions of the job model. A more simple one containing the jobs actual data and the full model also containing also the job-template definition.

If creating a job for the first time, where a job template does not exist, the full model is required.

Definition

This definition is needed when creating / updating a job with an existing job template.


Field Type Description (M)andatory / (O)ptional Default Value (If Optional)
Key String The identification of a job M (Mandatory if updating an existing job) null
PlannedTime DateTime? The date and time when the job is planned. e.g. 2018-01-30T12:23:43 O
 Current time
Duration Timespan If true, a job of this template can be created on the mobile. e.g. 00:30:00 (hh:mm:ss) O
 15 min
JobTemplateTitle
 String(200)
 The title of the existing job template to use when creating a new job M (Mandatory if not updating an existing job) null
JobTemplateId
 int The id of the existing job template to use when creating a new job
 O (Either JobTemplateTitle or JobTemplateId can be specified to identify the job template) null
Team String(200)     The team to assign the job to. This is used when creating a job which is not assigned to a user, so that only members of the given team can see the job. O null
UserEmail String(200)    
 Email address of the Goana-User which to assign the job to. If empty, the job will be created / updated without assignment. O null
Parameters
 List of Job Parameters
 A list of job parameters M null
Status String(200)    
 Status of the job (Readonly) O null



Full Definition

Additionaly to the fields above, the following specification is needed when creating a job without an existing job template.


Field Type Description (M)andatory / (O)ptional Default Value (If Optional)
ColorCode String(7)
 Color Code of the Job-Type, e.g. "#CACACA" O
 #015167
CanCreateOnMobile
 bool If true, a job of this template can be created on the mobile O
 false
CanEditOnMobile
 bool
 If true, a job of this template can be edited (without changing the status) on the mobile
 O

 false
CanDeleteOnMobile
 bool
 If true, a job of this template can be deleted on the mobile.
 O
 false
DefaultDuration TimeSpan The default duration of a job of this template O 0:15h
Parameters List of Job Parameters (Full definition) The list of job parameters. M null



Example

[
  {
    "Key": "7d901dd9-9bde-4831-9636-b5b64aedb642",
    "PlannedTime": "2018-01-25T12:23:43.683",
    "Duration": "00:15:00",
    "JobTemplateTitle": "All Parameters",
    "JobTemplateId": 1328,
    "UserEmail": "travis@sequens.ch",
    "Parameters": [
      ...
    ]
  }
]