contacts

Contact points related operations

Précédentme Suivantworkers

Dernière mise à jour il y a 3 mois

Cet article vous a-t-il été utile ?

Creates a contact point

post

/contacts/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

contact_formstring

The contact point's contact form

emailstringrequired

The contact point's email

idstring

The contact point's identifier

namestringrequired

The contact point's name

rolestringrequired

The role of the contact

organizationall of

The producer organization

ownerall of

The user information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/contacts/' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","name":"text","role":"text","organization":{"class":"text","id":"text","slug":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","slug":"text","uri":"text"}}'

200

400

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "role": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Deletes a contact point given its identifier

delete

/contacts/{contact_point}//

Path parameters

contact_pointstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/contacts/{contact_point}/'

204

404

No body

Contact point deleted

Get a contact point given its identifier

get

/contacts/{contact_point}//

Path parameters

contact_pointstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/contacts/{contact_point}/'

200

404

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "role": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

parameters

/contacts/{contact_point}//

Path parameters

contact_pointstringrequired

cURL

JavaScript

Python

HTTP

curl -L \
  --request PARAMETERS \
  --url '//www.data.gouv.fr/api/1/contacts/{contact_point}/'

Updates a contact point given its identifier

put

/contacts/{contact_point}//

Path parameters

contact_pointstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

contact_formstring

The contact point's contact form

emailstringrequired

The contact point's email

idstring

The contact point's identifier

namestringrequired

The contact point's name

rolestringrequired

The role of the contact

organizationall of

The producer organization

ownerall of

The user information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/contacts/{contact_point}/' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","name":"text","role":"text","organization":{"class":"text","id":"text","slug":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","slug":"text","uri":"text"}}'

200

400

404

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "role": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success