contacts

Contact points related operations

Creates a contact point

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

application/json

contact_formstringOptionnel

emailstring · max: 255Optionnel

namestring · max: 255Requis

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

rolestring · enumRequisExample: contactValeurs possibles:

Réponses

200

Success

application/json

contact_formstringOptionnel

emailstring · max: 255Optionnel

idstringLecture seuleRequis

namestring · max: 255Requis

rolestring · enumRequisExample: contactValeurs possibles:

400

Validation error

post/contacts/

HTTPcURLJavaScriptPython

POST /api/1/contacts/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "contact_form": "text",
  "email": "text",
  "name": "text",
  "organization": "text",
  "owner": "text",
  "role": "contact"
}

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "contact"
}

Deletes a contact point given its identifier

delete

Paramètres de chemin

contact_pointstringRequis

Réponses

204

Contact point deleted

Aucun contenu

404

Contact point not found

delete/contacts/{contact_point}/

HTTPcURLJavaScriptPython

DELETE /api/1/contacts/{contact_point}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

Get a contact point given its identifier

get

Paramètres de chemin

contact_pointstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

contact_formstringOptionnel

emailstring · max: 255Optionnel

idstringLecture seuleRequis

namestring · max: 255Requis

rolestring · enumRequisExample: contactValeurs possibles:

404

Contact point not found

get/contacts/{contact_point}/

HTTPcURLJavaScriptPython

GET /api/1/contacts/{contact_point}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "contact"
}

parameters

Paramètres de chemin

contact_pointstringRequis

parameters/contacts/{contact_point}/

HTTPcURLJavaScriptPython

PARAMETERS /api/1/contacts/{contact_point}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Updates a contact point given its identifier

put

Paramètres de chemin

contact_pointstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

application/json

contact_formstringOptionnel

emailstring · max: 255Optionnel

namestring · max: 255Requis

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

rolestring · enumRequisExample: contactValeurs possibles:

Réponses

200

Success

application/json

contact_formstringOptionnel

emailstring · max: 255Optionnel

idstringLecture seuleRequis

namestring · max: 255Requis

rolestring · enumRequisExample: contactValeurs possibles:

400

Validation error

404

Contact point not found

put/contacts/{contact_point}/

HTTPcURLJavaScriptPython

PUT /api/1/contacts/{contact_point}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "contact_form": "text",
  "email": "text",
  "name": "text",
  "organization": "text",
  "owner": "text",
  "role": "contact"
}

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "contact"
}