Entités

Récupération de la liste des entités

get

Récupération de la liste des entités

Authorizations

basicAuth

AuthorizationstringRequired

Responses

200

Opération réalisée avec succès

application/json

get

/entities

HTTPcURLJavaScriptPython

GET /rest/entities HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "entities": [
    {
      "id": "VILLE",
      "entity_id": "VILLE",
      "entity_label": "Ville de Mem en Provence",
      "parent_entity_id": "",
      "parent_id": null,
      "serialId": 1,
      "parentSerialId": "#",
      "parent": "#",
      "icon": "fa fa-building",
      "allowed": true,
      "state": {},
      "text": "Ville de Mem en Provence"
    }
  ]
}

Récupération d'une entité par son identifiant

get

Récupération d'une entité par son identifiant

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

doctype_idstringRequiredExample: 1002

Responses

200

Opération réalisée avec succès

application/json

idnumberOptionalExample: 1

entity_labelstringOptionalExample: Ville de Mem en Provence

short_labelstringOptionalExample: Ville de Mem en Provence

entity_full_namestringOptionalExample: Ville de Mem en Provence

entity_typestringOptionalExample: Direction

entity_idstringOptionalExample: VILLE

enabledstringOptionalExample: Y

parent_entity_idstringOptionalExample: DGS

addressNumbernumberOptionalExample: 98

addressStreetstringOptionalExample: Hotel de ville

addressAdditional1stringOptionalExample: Place de la Fraternité

addressAdditional2stringOptional

addressPostcodestringOptionalExample: 84000

addressTownstringOptionalExample: MEM-en-Provence

addressCountrystringOptionalExample: France

emailstringOptionalExample: [e-mail]

get

/entities/{entity_id}

HTTPcURLJavaScriptPython

GET /rest/entities/{entity_id} HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "id": 1,
  "entity_label": "Ville de Mem en Provence",
  "short_label": "Ville de Mem en Provence",
  "entity_full_name": "Ville de Mem en Provence",
  "entity_type": "Direction",
  "entity_id": "VILLE",
  "enabled": "Y",
  "parent_entity_id": "DGS",
  "addressNumber": 98,
  "addressStreet": "Hotel de ville",
  "addressAdditional1": "Place de la Fraternité",
  "addressAdditional2": "",
  "addressPostcode": "84000",
  "addressTown": "MEM-en-Provence",
  "addressCountry": "France",
  "email": "[e-mail]"
}

Récupération de la liste des utilisateurs d'une entités

get

Récupération de la liste des utilisateurs d'une entités

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

entity_idstringRequiredExample: 5

Responses

200

Opération réalisée avec succès

application/json

get

/entities/{entity_id}/users

HTTPcURLJavaScriptPython

GET /rest/entities/{entity_id}/users HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "users": [
    {
      "id": 5,
      "user_id": "fbelhami",
      "firstname": "Ferdinand",
      "lastname": "Belhami",
      "labelToDisplay": "Ferdinand Belhami",
      "descriptionToDisplay": "Direction Générale des Services"
    }
  ]
}