Nomadia Field Service - Administration

Warning: authentication required

The integration web service requires authentication through a "commonInfo" member added to every request made.
Please fill at least the userLogin and userPassword to access the integration web service.
(A "key" may be required too, please ask to your Nomadia Field Service administrator or Nomadia Field Service support)
Then, click on the following "Add commonInfo button" to update default requests with it:

  "commonInfo":{
    "version":"1.0",
    "key":"",
    "language":"en",
    "userLogin":"admin",
    "userPassword":"foo"
  }

its id (AREAID) define in the external application (yours)
its name (AREANAME) define its name as it appears in user interface
its domain (DOMAIN) define the name of the domain it's belonging to

ACTIVE

DESCRIPTION

ABBREVIATION

Area CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "AREAID",
      "value" : "AREA_1"
    }, {
      "name" : "AREANAME",
      "value" : "My First Area"
    }, {
      "name" : "DOMAIN",
      "value" : "My Domain"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (WORKSITEID) define in the external application (yours)
its name (WORKSITENAME) define its name as it appears in user interface

its postal address (ADDRESS,CITY,CODEZONE,DISTRICT,COUNTRY) define the address location
or its earth coordinates (XGEO,YGEO) define the location by GPS coordinates (longitude,latitude)
or its map coordinates (X,Y) define the location by map coordinates (projected on paper)

ACTIVE

WORKSITETYPE=D

DESCRIPTION

ABBREVIATION

Worksite CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId": "null",
  "properties": {
    "property": [
      {
        "name": "WORKSITEID",
        "value": "WORKSITE_1"
      },
      {
        "name": "WORKSITENAME",
        "value": "My First Worksite"
      },
      {
        "name": "ADDRESS",
        "value": "152 avenue Aristide Briand"
      },
      {
        "name": "CITY",
        "value": "BAGNEUX"
      },
      {
        "name": "CODEZONE",
        "value": "92"
      },
      {
        "name": "DISTRICT",
        "value": ""
      },
      {
        "name": "COUNTRY",
        "value": "FR"
      },
      {
        "name": "XGEO",
        "value": "2.321397"
      },
      {
        "name": "YGEO",
        "value": "48.796546"
      },
      {
        "name": "AREAID",
        "value": "AREA_1"
      }
    ]
  },
  "dateFormat": "dd/MM/yyyy",
  "separatorInListOfValues": ",",
  "geocodingOptions": {
    "geocodingType": "AT_STREET_NUMBER",
    "minScore": 0.8,
    "defaultWorkSiteId": ""
  },
  "commonInfo": {
    "version": "1",
    "key": "",
    "language": "en",
    "userLogin": "admin",
    "userPassword": ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

NEEDED before create a user !

its id (FUNCTIONID) define the ID of the user function key into your system (used to update)
its id (FUNCTIONNAME) define the NAME of the user function into the company

its postal address (ADDRESS,CITY,CODEZONE,DISTRICT,COUNTRY) define the address location to start on morning
or its earth coordinates (XGEO,YGEO) define the location by GPS coordinates (longitude,latitude)
or its map coordinates (X,Y) define the location by map coordinates (projected on paper)

its area (AREAID) define its area

ACTIVE

DESCRIPTION

ABBREVIATION

ResourceFunction CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "FUNCTIONID",
      "value" : "FUNCTION_1"
    }, {
      "name" : "FUNCTIONNAME",
      "value" : "Planner"
    }, {
      "name" : "AREAID",
      "value" : "AREA_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

so you NEED to define your company functions before !

its id (RESOURCEID) define its key into your system (used to update)
its name (RESOURCEFIRSTNAME) define its firstname as it appears in user interface
its name (RESOURCELASTNAME) define its lastname as it appears in user interface

its postal address (ADDRESS,CITY,CODEZONE,DISTRICT,COUNTRY) define the address location to start on morning
or its earth coordinates (XGEO,YGEO) define the location by GPS coordinates (longitude,latitude)
or its map coordinates (X,Y) define the location by map coordinates (projected on paper)

its postal address (ADDRESS2,CITY2,CODEZONE2,DISTRICT2,COUNTRY2) define the address location to return on evening
or its earth coordinates (XGEO2,YGEO2) define the location by GPS coordinates (longitude,latitude)
or its map coordinates (X2,Y2) define the location by map coordinates (projected on paper)

its function (FUNCTIONID) define its function inside the company

ACTIVE

WORSITETYPE=D

DESCRIPTION

ABBREVIATION

HumanResource CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId": "null",
  "properties": {
    "property": [
      {
        "name": "RESOURCEID",
        "value": "USER_1"
      },
      {
        "name": "RESOURCEFIRSTNAME",
        "value": "Firstname"
      },
      {
        "name": "RESOURCELASTNAME",
        "value": "Lastname"
      },
      {
        "name": "ADDRESS",
        "value": "152 avenue Aristide Briand"
      },
      {
        "name": "CITY",
        "value": "BAGNEUX"
      },
      {
        "name": "CODEZONE",
        "value": "92"
      },
      {
        "name": "DISTRICT",
        "value": ""
      },
      {
        "name": "COUNTRY",
        "value": "FR"
      },
      {
        "name": "XGEO",
        "value": "2.321397"
      },
      {
        "name": "YGEO",
        "value": "48.796546"
      },
      {
        "name": "WORKSITEID",
        "value": "WORKSITE_1"
      }
    ]
  },
  "dateFormat": "dd/MM/yyyy",
  "separatorInListOfValues": ",",
  "geocodingOptions": {
    "geocodingType": "AT_STREET_NUMBER",
    "minScore": 0.8,
    "defaultWorkSiteId": ""
  },
  "commonInfo": {
    "version": "1",
    "key": "",
    "language": "en",
    "userLogin": "admin",
    "userPassword": ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (WORKDAYTYPEID) define in the external application (yours, and used to update)
its name (WORKDAYTYPENAME) define its name as it appears in user interface
its day begin time (DAYBEGINTIME) define the time (hours) for the beginning of the day
its day end time (DAYENDTIME) define the time (hours) for the ending of the day

ACTIVE

DAYISWORKED

DESCRIPTION

ABBREVIATION

AREAID

WORKSITEID

GROUPNAME

WorkdayType CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "WORKDAYTYPEID",
      "value" : "MoTuWeThFr_1"
    }, {
      "name" : "WORKDAYTYPENAME",
      "value" : "MyDayWorked"
    }, {
      "name" : "DAYISWORKED",
      "value" : "1"
    }, {
      "name" : "DAYBEGINTIME",
      "value" : "08:00"
    }, {
      "name" : "DAYENDTIME",
      "value" : "18:00"
    }, {
      "name" : "DAYBEGINLUNCHPERIOD",
      "value" : "12:00"
    }, {
      "name" : "DAYENDLUNCHPERIOD",
      "value" : "14:00"
    }, {
      "name" : "DAYLUNCHDURATION",
      "value" : "45"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (ID) define in the external application (yours, and used to update)
its name (NAME) define its name as it appears in user interface
its list of day templates (WORKDAYTYPES) define the list of each day templates

ACTIVE

STARTDAY

DESCRIPTION

ABBREVIATION

AREAID

WORKSITEID

GROUPNAME

WorkWeekType CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "ID",
      "value" : "StdWorkedWeek_1"
    }, {
      "name" : "NAME",
      "value" : "MyWorkedWeekTemplate"
    }, {
      "name" : "WORKDAYTYPES",
      "value" : "MoTuWeThFr_1, MoTuWeThFr_1, MoTuWeThFr_1, MoTuWeThFr_1, MoTuWeThFr_1, SaSu_2, SaSu_2"
    }, {
      "name" : "STARTDAY",
      "value" : "1"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (TASKTYPESGROUPID) define in the external application (yours, and used to update)
its name (TASKTYPESGROUPNAME) define its name as it appears in user interface

ACTIVE

DESCRIPTION

ABBREVIATION

COLOR

TaskTypeGroup CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "TASKTYPESGROUPID",
      "value" : "TASKTYPESGROUP_1"
    }, {
      "name" : "TASKTYPESGROUPNAME",
      "value" : "MyTaskTypesGroup"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (TASKTYPESID) define in the external application (yours, and used to update)
its name (TASKTYPESNAME) define its name as it appears in user interface
its tasktypesgroup (TASKTYPESGROUPID) define th group of task type it belongs to
its duration (DURATION) define the default duration as it appears in user interface when creation a new mission according ot its task type. That duration is define in minutes (positiv not nulle)

ACTIVE

DESCRIPTION

ABBREVIATION

COLOR

TaskType CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "TASKTYPESID",
      "value" : "TASKTYPES_1"
    }, {
      "name" : "TASKTYPESNAME",
      "value" : "MyTaskType 1"
    }, {
      "name" : "TASKTYPESGROUPID",
      "value" : "TASKTYPESGROUP_1"
    }, {
      "name" : "DURATION",
      "value" : "90"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (UNAVAILABILITYTYPESID) define in the external application (yours, and used to update)
its name (UNAVAILABILITYTYPENAME) define its name as it appears in user interface
its duration (DEFAULT_DURATION) define the default duration as it appears in user interface when creation a new unavailability according ot its unavailability type. That duration is define in minutes (positiv not nulle)
its default location (DEFAULT_LOCATION) define if that kind of unavailability is geolocalized at worker home base, at worker worksite or at a specific address (need to be define further)

ACTIVE

ISWORKTIME

DESCRIPTION

ABBREVIATION

COLOR

ISMULTIRESOURCE

ISREQUIREDVALIDATION

UnavailabilityType CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "UNAVAILABILITYTYPEID",
      "value" : "UNAVAILABILITYTYPE_1"
    }, {
      "name" : "UNAVAILABILITYNAME",
      "value" : "MyMeetingType 1"
    }, {
      "name" : "DEFAULT_DURATION",
      "value" : "90"
    }, {
      "name" : "ISWORKTIME",
      "value" : "1"
    }, {
      "name" : "ISREQUIREVALIDATION",
      "value" : "0"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (UNAVAILABILITYTYPESID) define in the external application (yours, and used to update)
its name (UNAVAILABILITYTYPENAME) define its name as it appears in user interface
its duration (DEFAULT_DURATION) define the default duration as it appears in user interface when creation a new unavailability according ot its unavailability type. That duration is define in minutes (positiv not nulle)
its default location (DEFAULT_LOCATION) define if that kind of unavailability is geolocalized at worker home base, at worker worksite or at a specific address (need to be define further)

ACTIVE

ISWORKTIME

DESCRIPTION

ABBREVIATION

COLOR

ISMULTIRESOURCE

ISREQUIREDVALIDATION

UnavailabilityType CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntityFromProperties.json

SetEntityFromPropertiesRequest
Schema	Observation

SetEntityFromPropertiesResponse
Schema	Observation


        {
  "sessionId" : "",
  "properties" : {
    "property" : [ {
      "name" : "UNAVAILABILITYTYPEID",
      "value" : "UNAVAILABILITYTYPE_1"
    }, {
      "name" : "UNAVAILABILITYNAME",
      "value" : "MyMeetingType 1"
    }, {
      "name" : "DEFAULT_DURATION",
      "value" : "90"
    }, {
      "name" : "ISWORKTIME",
      "value" : "0"
    }, {
      "name" : "ISREQUIREVALIDATION",
      "value" : "1"
    }, {
      "name" : "WORKSITEID",
      "value" : "WORKSITE_1"
    } ]
  },
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "isSuccessful" : true,
  "errorMessage" : ""
}

its id (SECTORID) define in the external application (yours)
its name (SECTORNAME) define its name as it appears in user interface

its postal address (ADDRESS,CITY,CODEZONE,DISTRICT,COUNTRY) define the address location
or its earth coordinates (XGEO,YGEO) define the location by GPS coordinates (longitude,latitude)
or its map coordinates (X,Y) define the location by map coordinates (projected on paper)

ACTIVE

WORKSITETYPE=S

DESCRIPTION

ABBREVIATION

Worksite CSV Model properties

See samples

https://otgs-api-doc.geoconcept.com:443/otgs/rest/v1/entities/json/setEntitiesFromCsv.json

SetEntitiesFromCsvRequest
Schema	Observation

SetEntitiesFromCsvResponse
Schema	Observation


        {
  "csvData" : "\"SECTORID\";\"SECTORNAME\";\"ADDRESS\";\"CITY\";\"CODEZONE\";\"DISTRICT\";\"COUNTRY\";\"XGEO\";\"YGEO\";\"AREAID\"\n\"SECTOR_1\";\"My First Sector\";\"\";\"BAGNEUX\";\"92\";\"\";\"FR\";\"2.321397\";\"48.796546\";\"AREA_1\"\n\"SECTOR_2\";\"My Second Sector\";\"\";\"CACHAN\";\"94\";\"\";\"FR\";\"2.3333\";\"48.7833\";\"AREA_1\"",
  "dataSeparator" : ";",
  "textDelimiter" : "\"",
  "dateFormat" : "dd/MM/yyyy",
  "separatorInListOfValues" : ",",
  "geocodingOptions" : {
    "geocodingType" : "AT_STREET_NUMBER",
    "minScore" : 0.8,
    "defaultWorkSiteId" : ""
  },
  "commonInfo" : {
    "version" : "1",
    "key" : "",
    "language" : "en",
    "userLogin" : "admin",
    "userPassword" : ""
  }
}

        {
  "sessionId": "932769af-d272-4d55-a554-7b11ce518a85",
  "result": {
    "success": true,
    "detail": ""
  },
  "isSuccessful": true,
  "nbSuccess": "2",
  "nbFailure": "0",
  "htmlSummary": "
\nHeader;true;Import  : Sector\nSECTORID;SECTORNAME;ADDRESS;CITY;CODEZONE;DISTRICT;COUNTRY;XGEO;YGEO;;
\n1;true; Sector Id : SECTOR_1  (new)  successfully  added 
\n2;true; Sector Id : SECTOR_2  (new)  successfully  added ",
  "errorMessage": ""
}

Data integration tutorial

Warning: authentication required

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples

Description

Procedure

Request

Response

Samples