Back to top

LIS_CSP V0.1

Notes

All dates used in requests are UTC+00 dates, and formatted in ISO YYYY-MM-DDTHH:mm:ssZ.

Authentication

In order to access the API, you need an authentication token. Each time a User signs-in, a token is generated. You must send it with each subsequent request. Tokens are invalidated when a User signs-out or when a User signs-in again.

The token is featured in the response, in the field authentication_token.

Sign-in

Get a token
POST/users/sign_in

Get an authentication token using a Username, a Password and a NGS identifier.

Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "user": {
    "email": "nicolas.prat@helileo.com",
    "password": "bobleponge",
    "lis_id": "APPLUS"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user_id": "57c6a4c22a227616f229a848",
  "email": "nicolas.prat@helileo.com",
  "status": "ok",
  "authentication_token": "5xZy936CKphiqo5-RFnz",
  "current_ngs_id": null,
  "current_lis_id": "APPLUS"
}

Sign-out

Release a token
DELETE/users/sign_out

Release an authentication token.

Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
X-User-Email: nicolas.prat@helileo.com
X-User-Token: 5xZy936CKphiqo5-RFnz
Response  200
HideShow
Headers
Content-Type: application/json

Notifications

Generation

Generation
POST/notifications/generation

This request posts a generation (create) XML message from the LIS. The response is the current status of the item (bGENERATEDb). If there exists an item with the same ID, the response features simply a message indicating this.

Request
HideShow
Headers
Content-Type: application/xml
Accept: application/json
X-User-Email: nicolas.prat@helileo.com
X-User-Token: 5xZy936CKphiqo5-RFnz
Body
<?xml version="1.0" encoding="ISO-8859-1"?>
<Interchanges id="1470300912661" from="APPLUS" to="GLNTRANSA">
<MessageSet id="105512" icid="1470300912661" date="04/08/2016 10:55:12">
<Destinataire user="GLNTRANSA" tiersProf="GLNTRANSA"/>
<Emetteur user="APPLUS" tiersProf="APPLUS"/>
<Messages>
<Notification id="ECV07768019" type="CEN" action="CREATE" ref="MAR0408161">
<constat-enlevement>
<reference-cst sic="CEN14666607" hist="1" amq="ECV07768019" agfret="AP+CBK02646888" inter="INT0408161" date="04/08/2016 10:54" statut="VAU" lastdate="04/08/2016 10:54" agsic="CBK02646888" dos="DOS01851052" extdos="REFDOS0408162" rang="1" sens="SM"/>
<voyage-cst ser="SER00112894"/>
<lieu-cst zone="BOD" zone-lib="BORDEAUX" lieu="GAYLUSMJ" lieu-lib="44.862392,-0.72413"/>
<tiers-cst manut="GLNTRANSA" manut-lib="GALENA TRANSPORT" agfret="GLNTRANSA" agfret-lib="GALENA TRANSPORT" amq="GLNTRANSA" amq-lib="GALENA TRANSPORT"/>
<lmarchandise-cst ref="MAR0408161" nb="1" code="BX" code-lib="BOITE" poids="1">
<mesurage-cst nb="1" code="BX" code-lib="BOITE">
<marques>MARQUES</marques>
</mesurage-cst>
</lmarchandise-cst>
<date-cst horodatage="04/08/2016 10:53" sic="04/08/2016 10:54"/>
<lieux-cst tbt="FRBOD" tbt-lib="BORDEAUX/FRANCE" fin="FRBOD" fin-lib="BORDEAUX/FRANCE"/>
<acheminement-cst sic="RTE" sic-lib="ROUTE" nom="TRANSPORTEUR"/>
</constat-enlevement>
</Notification>
</Messages>
</MessageSet>
</Interchanges>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "_id": "ECV07768019",
  "designation": "DESCRIPTION",
  "destination": null,
  "horodatage": "03/08/2016 15:48",
  "location": [
    44.862392,
    -0.72413
  ],
  "marques": "MARQUES",
  "ngs_id": null,
  "notification": {
    "Interchanges": {
      "MessageSet": {
        "Destinataire": {
          "@user": "GLNTRANSA",
          "@tiersProf": "GLNTRANSA"
        },
        "Emetteur": {
          "@user": "APPLUS",
          "@tiersProf": "APPLUS"
        },
        "Messages": {
          "Notification": {
            "constat_enlevement": {
              "reference_cst": {
                "@sic": "CEN14666607",
                "@hist": "1",
                "@amq": "ECV07768019",
                "@agfret": "AP+CBK02646888",
                "@inter": "INT0408161",
                "@date": "04/08/2016 10:54",
                "@statut": "VAU",
                "@lastdate": "04/08/2016 10:54",
                "@agsic": "CBK02646888",
                "@dos": "DOS01851052",
                "@extdos": "REFDOS0408162",
                "@rang": "1",
                "@sens": "SM"
              },
              "voyage_cst": {
                "@ser": "SER00112894"
              },
              "lieu_cst": {
                "@zone": "BOD",
                "@zone_lib": "BORDEAUX",
                "@lieu": "GAYLUSMJ",
                "@lieu_lib": "44.862392,-0.72413"
              },
              "tiers_cst": {
                "@manut": "GLNTRANSA",
                "@manut_lib": "GALENA TRANSPORT",
                "@agfret": "GLNTRANSA",
                "@agfret_lib": "GALENA TRANSPORT",
                "@amq": "GLNTRANSA",
                "@amq_lib": "GALENA TRANSPORT"
              },
              "lmarchandise_cst": {
                "mesurage_cst": {
                  "marques": "MARQUES",
                  "@nb": "1",
                  "@code": "BX",
                  "@code_lib": "BOITE"
                },
                "@ref": "MAR0408161",
                "@nb": "1",
                "@code": "BX",
                "@code_lib": "BOITE",
                "@poids": "1"
              },
              "date_cst": {
                "@horodatage": "04/08/2016 10:53",
                "@sic": "04/08/2016 10:54"
              },
              "lieux_cst": {
                "@tbt": "FRBOD",
                "@tbt_lib": "BORDEAUX/FRANCE",
                "@fin": "FRBOD",
                "@fin_lib": "BORDEAUX/FRANCE"
              },
              "acheminement_cst": {
                "@sic": "RTE",
                "@sic_lib": "ROUTE",
                "@nom": "TRANSPORTEUR"
              }
            },
            "@id": "ECV07768019",
            "@type": "CEN",
            "@action": "CREATE",
            "@ref": "MAR0408161"
          }
        },
        "@id": "105512",
        "@icid": "1470300912661",
        "@date": "04/08/2016 10:55:12"
      },
      "@id": "1470300912661",
      "@from": "APPLUS",
      "@to": "GLNTRANSA"
    }
  },
  "status": "GENERATED"
}

Shipment

Shipment
POST/notifications/shipment

This request posts a shipment (pickup) XML message from the LIS. The response is the current status of the item (bPICKEDUPb).

Request
HideShow
Headers
Content-Type: application/xml
Accept: application/json
X-User-Email: nicolas.prat@helileo.com
X-User-Token: 5xZy936CKphiqo5-RFnz
Body
<?xml version="1.0" encoding="ISO-8859-1"?>
<Interchanges id="1470300912661" from="APPLUS" to="GLNTRANSA">
<MessageSet id="105512" icid="1470300912661" date="04/08/2016 10:55:12">
<Destinataire user="GLNTRANSA" tiersProf="GLNTRANSA"/>
<Emetteur user="APPLUS" tiersProf="APPLUS"/>
<Messages>
<Notification id="ECV07768019" type="CEN" action="CREATE" ref="MAR0408161">
<constat-enlevement>
<reference-cst sic="CEN14666607" hist="1" amq="ECV07768019" agfret="AP+CBK02646888" inter="INT0408161" date="04/08/2016 10:54" statut="VAU" lastdate="04/08/2016 10:54" agsic="CBK02646888" dos="DOS01851052" extdos="REFDOS0408162" rang="1" sens="SM"/>
<voyage-cst ser="SER00112894"/>
<lieu-cst zone="BOD" zone-lib="BORDEAUX" lieu="GAYLUSMJ" lieu-lib="44.862392,-0.72413"/>
<tiers-cst manut="GLNTRANSA" manut-lib="GALENA TRANSPORT" agfret="GLNTRANSA" agfret-lib="GALENA TRANSPORT" amq="GLNTRANSA" amq-lib="GALENA TRANSPORT"/>
<lmarchandise-cst ref="MAR0408161" nb="1" code="BX" code-lib="BOITE" poids="1">
<mesurage-cst nb="1" code="BX" code-lib="BOITE">
<marques>MARQUES</marques>
</mesurage-cst>
</lmarchandise-cst>
<date-cst horodatage="04/08/2016 10:53" sic="04/08/2016 10:54"/>
<lieux-cst tbt="FRBOD" tbt-lib="BORDEAUX/FRANCE" fin="FRBOD" fin-lib="BORDEAUX/FRANCE"/>
<acheminement-cst sic="RTE" sic-lib="ROUTE" nom="TRANSPORTEUR"/>
</constat-enlevement>
</Notification>
</Messages>
</MessageSet>
</Interchanges>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "_id": "ECV07768019",
  "designation": "DESCRIPTION",
  "destination": null,
  "horodatage": "03/08/2016 15:48",
  "location": [
    44.862392,
    -0.72413
  ],
  "marques": "MARQUES",
  "ngs_id": null,
  "notification": {
    "Interchanges": {
      "MessageSet": {
        "Destinataire": {
          "@user": "GLNTRANSA",
          "@tiersProf": "GLNTRANSA"
        },
        "Emetteur": {
          "@user": "APPLUS",
          "@tiersProf": "APPLUS"
        },
        "Messages": {
          "Notification": {
            "constat_enlevement": {
              "reference_cst": {
                "@sic": "CEN14666607",
                "@hist": "1",
                "@amq": "ECV07768019",
                "@agfret": "AP+CBK02646888",
                "@inter": "INT0408161",
                "@date": "04/08/2016 10:54",
                "@statut": "VAU",
                "@lastdate": "04/08/2016 10:54",
                "@agsic": "CBK02646888",
                "@dos": "DOS01851052",
                "@extdos": "REFDOS0408162",
                "@rang": "1",
                "@sens": "SM"
              },
              "voyage_cst": {
                "@ser": "SER00112894"
              },
              "lieu_cst": {
                "@zone": "BOD",
                "@zone_lib": "BORDEAUX",
                "@lieu": "GAYLUSMJ",
                "@lieu_lib": "44.862392,-0.72413"
              },
              "tiers_cst": {
                "@manut": "GLNTRANSA",
                "@manut_lib": "GALENA TRANSPORT",
                "@agfret": "GLNTRANSA",
                "@agfret_lib": "GALENA TRANSPORT",
                "@amq": "GLNTRANSA",
                "@amq_lib": "GALENA TRANSPORT"
              },
              "lmarchandise_cst": {
                "mesurage_cst": {
                  "marques": "MARQUES",
                  "@nb": "1",
                  "@code": "BX",
                  "@code_lib": "BOITE"
                },
                "@ref": "MAR0408161",
                "@nb": "1",
                "@code": "BX",
                "@code_lib": "BOITE",
                "@poids": "1"
              },
              "date_cst": {
                "@horodatage": "04/08/2016 10:53",
                "@sic": "04/08/2016 10:54"
              },
              "lieux_cst": {
                "@tbt": "FRBOD",
                "@tbt_lib": "BORDEAUX/FRANCE",
                "@fin": "FRBOD",
                "@fin_lib": "BORDEAUX/FRANCE"
              },
              "acheminement_cst": {
                "@sic": "RTE",
                "@sic_lib": "ROUTE",
                "@nom": "TRANSPORTEUR"
              }
            },
            "@id": "ECV07768019",
            "@type": "CEN",
            "@action": "CREATE",
            "@ref": "MAR0408161"
          }
        },
        "@id": "105512",
        "@icid": "1470300912661",
        "@date": "04/08/2016 10:55:12"
      },
      "@id": "1470300912661",
      "@from": "APPLUS",
      "@to": "GLNTRANSA"
    }
  },
  "status": "PICKEDUP"
}

Delivery

Delivery
POST/notifications/delivery

This request posts a delivery XML message from the LIS. The response is the current status of the item (bDELIVEREDb).

Request
HideShow
Headers
Content-Type: application/xml
Accept: application/json
X-User-Email: nicolas.prat@helileo.com
X-User-Token: 5xZy936CKphiqo5-RFnz
Body
<?xml version="1.0" encoding="ISO-8859-1"?>
<Interchanges id="1470232277805" from="APPLUS" to="GLNTRANSA"><MessageSet id="155117" icid="1470232277805" date="03/08/2016 15:51:17"><Destinataire user="GLNTRANSA" tiersProf="GLNTRANSA"/><Emetteur user="APPLUS" tiersProf="APPLUS"/><Messages><Notification id="ECV07768019" type="CRE" action="CREATE" ref="MAR0308161"><constat-reception><reference-cst sic="CRE14666604" hist="1" amq="ECV07768019" agfret="REFDOS0308161" date="03/08/2016 15:50" statut="VAU" lastdate="03/08/2016 15:50" agsic="CBK02646887" dos="DOS01851051" extdos="REFDOS0308161" rang="1" sens="SM"/><voyage-cst ser="SER00112894"/><lieu-cst zone="BOD" zone-lib="BORDEAUX" lieu="GAYLUSMJ" lieu-lib="44.882392,-0.73413" loc="LOT"/><tiers-cst manut="GLNTRANSA" manut-lib="GALENA TRANSPORT" amq="GLNTRANSA" amq-lib="GALENA TRANSPORT"/><lmarchandise-cst sic="COV43773379" ref="MAR0308161" nb="1" code="BX" code-lib="BOITE" poids="1" vol="1" volmes="1" ind-conforme="N"><mesurage-cst nb="1" code="BX" code-lib="BOITE" long="1" larg="1" haut="1" vol="1"><marques>MARQUES</marques>
</mesurage-cst>
</lmarchandise-cst>
<date-cst horodatage="03/08/2016 15:48" sic="03/08/2016 15:50"/><lieux-cst tbt="FRBOD" tbt-lib="BORDEAUX/FRANCE" fin="FRBOD" fin-lib="BORDEAUX/FRANCE"/><acheminement-cst sic="RTE" sic-lib="ROUTE" id="TRANSPORT" nom="TRANSPORTEUR"/></constat-reception>
</Notification>
</Messages>
</MessageSet>
</Interchanges>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "_id": "ECV07768019",
  "designation": "DESCRIPTION",
  "destination": null,
  "horodatage": "03/08/2016 15:48",
  "location": [
    44.862392,
    -0.72413
  ],
  "marques": "MARQUES",
  "ngs_id": null,
  "notification": {
    "Interchanges": {
      "MessageSet": {
        "Destinataire": {
          "@user": "GLNTRANSA",
          "@tiersProf": "GLNTRANSA"
        },
        "Emetteur": {
          "@user": "APPLUS",
          "@tiersProf": "APPLUS"
        },
        "Messages": {
          "Notification": {
            "constat_enlevement": {
              "reference_cst": {
                "@sic": "CEN14666607",
                "@hist": "1",
                "@amq": "ECV07768019",
                "@agfret": "AP+CBK02646888",
                "@inter": "INT0408161",
                "@date": "04/08/2016 10:54",
                "@statut": "VAU",
                "@lastdate": "04/08/2016 10:54",
                "@agsic": "CBK02646888",
                "@dos": "DOS01851052",
                "@extdos": "REFDOS0408162",
                "@rang": "1",
                "@sens": "SM"
              },
              "voyage_cst": {
                "@ser": "SER00112894"
              },
              "lieu_cst": {
                "@zone": "BOD",
                "@zone_lib": "BORDEAUX",
                "@lieu": "GAYLUSMJ",
                "@lieu_lib": "44.862392,-0.72413"
              },
              "tiers_cst": {
                "@manut": "GLNTRANSA",
                "@manut_lib": "GALENA TRANSPORT",
                "@agfret": "GLNTRANSA",
                "@agfret_lib": "GALENA TRANSPORT",
                "@amq": "GLNTRANSA",
                "@amq_lib": "GALENA TRANSPORT"
              },
              "lmarchandise_cst": {
                "mesurage_cst": {
                  "marques": "MARQUES",
                  "@nb": "1",
                  "@code": "BX",
                  "@code_lib": "BOITE"
                },
                "@ref": "MAR0408161",
                "@nb": "1",
                "@code": "BX",
                "@code_lib": "BOITE",
                "@poids": "1"
              },
              "date_cst": {
                "@horodatage": "04/08/2016 10:53",
                "@sic": "04/08/2016 10:54"
              },
              "lieux_cst": {
                "@tbt": "FRBOD",
                "@tbt_lib": "BORDEAUX/FRANCE",
                "@fin": "FRBOD",
                "@fin_lib": "BORDEAUX/FRANCE"
              },
              "acheminement_cst": {
                "@sic": "RTE",
                "@sic_lib": "ROUTE",
                "@nom": "TRANSPORTEUR"
              }
            },
            "@id": "ECV07768019",
            "@type": "CEN",
            "@action": "CREATE",
            "@ref": "MAR0408161"
          }
        },
        "@id": "105512",
        "@icid": "1470300912661",
        "@date": "04/08/2016 10:55:12"
      },
      "@id": "1470300912661",
      "@from": "APPLUS",
      "@to": "GLNTRANSA"
    }
  },
  "status": "DELIVERED"
}

Generated by aglio on 13 Sep 2016