return to index

Nomadia Field Service API: Status Types

Nomadia Field Service Status (APPOINTMENT.STATUS)


Appointment Unknown State - Integration use
Property Data type Value Description
Unknown Integer 0 This status is NOT a true status and it is NOT stored into database. It is used to update existing appointment when tierce application (you) don't know what is the current status into OTGS database. So, when you want tu update appointment (from CSV or circulation) without knowing the current status into OTGS, you can set status to 0. The system try to maintain the current status unless this is not possible (constraint violation).

Appointment Macro State - Candidate ("M100")
Property Data type Value Description
Requested Integer 21 Appointment is not in the schedule. No resource, no date and no time are set
Suspended
Integer
6
Appointment is out of the schedule and not automatically optimized. Waiting for an action (scheduling, reactivation or cancelling) from the user

Appointment Macro State - Scheduled ("M200")
Property Data type Value Description
Planned Integer 2 Appointment is in the schedule. Resource may change, date and time may change
Accepted Integer 28 Appointment is in the schedule. Resource may NOT change, date and time may change
Reserved Integer 30 Appointment is in the schedule. Resource may change, date and time may NOT change
Confirmed Integer 31 Appointment is in the schedule. Resource may NOT change, date and time may NOT change

Appointment Macro State - Achieved ("M300")
Property Data type Value Description
Realized
Integer
3
Appointment has been done and declared achieved as it was planned
Shifted
Integer
33
Appointment has been done and declared achieved but different as planned
Happened
Integer
35
Appointment has been done and declared achieved but it was not planned/reserved/confirmed before

Appointment Macro State - Cancelled ("M400")
Property Data type Value Description
Removed
Integer
12
Appointment has been removed out of the scheduling system
Abandonned
Integer
10
Appointment is abandonned once and for all

Appointment Macro State - Aside ("M500")
Property Data type Value Description
Ignored
Integer
9
Appointment has been exited from the system. Ignored in the whole processing, until it is restored
Externalized
Integer
32
Appointment is to be done by a subcontractor
If the subcontractor cannot handle it, he can return it with the progression step BACK_SCHEDULING(2)

Appointment Macro State - Archived
Property Data type Value Description
Historized
Integer
40
Appointment is NOT managed. It is kept for history retrieval

Nomadia Field Service Progress states (APPOINTMENT.PROGRESSIONSTEP)

Appointment progress
Property Data type Value Description
In preparation Integer -10 Appointment is defined, but not inside the scheduling system - Possible associated statuses: 21
Scheduling Integer 0 Appointment is defined inside the scheduling system - Possible associated statuses: 21,2,6,29,30,31
Back scheduling Integer 2 Appointment has not been achieved on scheduled time and has been reactivated
Merged Integer 3 Appointment is abandonned because of being merged with another one - Possible associated statuses: 21
Supported Integer 5 Appointment is accepted by the resource to work on it - Possible associated statuses: 21,2
Ongoing Integer 10 Appointment is ongoing, the resource has declared working on it- Possible associated statuses: 2,29,30,31,3,33,35
Partially completed
Integer
15
Appointment is partially done - Possible associated statuses: 3,33,35,10,12
Completed
Integer
20
Appointment is fully done - Possible associated states: 3,33,35,10,12
Closed
Integer
100
Appointment is closed (administrative, judicial, financial) - Possible associated states: 3,33,35,10,12

return to index

Nomadia Field Service Achievement Status (APPOINTMENT.ACHIEVEMENT_STATUS/APPOINTMENT.ACHIEVEMENT_RESOURCES)

Achievement Status
Property Data type Value Description
None Integer 0 None
STATUS_STARTED Integer 1 The achievement is started
STATUS_STOPPED Integer 2 The achievement is stopped (paused)
STATUS_RESUMED Integer 3 The achievement is resumed (after a pause)
STATUS_TERMINATED Integer 4 The achievement is terminated
STATUS_TRIP_STARTED Integer 5 The trip to achievement location is started
STATUS_TRIP_TERMINATED Integer 6 The trip to achievement location is terminated
STATUS_TRIP_STOPPED Integer 7 The trip to achievement location is stopped (paused)
STATUS_TRIP_RESUMED Integer 8 The trip to achievement location is resumed (resumed)
STATUS_UNSUCCESSFULL Integer 9 The achievement is unsuccessful
STATUS_TRIP_UNSUCCESSFULL Integer 10 The trip to achievement location is unsuccessful

return to index

Nomadia Field Service Last Notification Status (APPOINTMENT.NOTIFICATIONSTATUS/APPOINTMENT.NOTIFICATIONRESOURCES)


See detail on next page
return to index

Nomadia Field Service Unavailability Status (UNAVAILABILITY.STATUS)


See detail on next page
return to index