transfer

Précédentposts Suivantnotifications

Dernière mise à jour il y a 1 an

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

Fetch a transfer request given its identifier

get

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/transfer/{id}/'

200

{
  "comment": "text",
  "created": "2025-03-25T05:00:16.425Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-03-25T05:00:16.425Z",
  "status": "pending",
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/transfer/'

200

[
  {
    "comment": "text",
    "created": "2025-03-25T05:00:16.425Z",
    "id": "text",
    "owner": {
      "class": "text",
      "id": "text"
    },
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "reponse_comment": "text",
    "responded": "2025-03-25T05:00:16.425Z",
    "status": "pending",
    "subject": {
      "class": "text",
      "id": "text"
    },
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
]

Success

Initiate transfer request

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

commentstringrequired

An explanation about the transfer request

recipientall ofrequired

The transfer recipient, either an user or an organization

subjectall ofrequired

The transfered subject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/transfer/' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "text",
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "subject": {
      "class": "text",
      "id": "text"
    }
  }'

200

{
  "comment": "text",
  "created": "2025-03-25T05:00:16.425Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-03-25T05:00:16.425Z",
  "status": "pending",
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Respond to a transfer request

post

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

commentstringoptional

An optional comment about the transfer response

responsestring · enumrequired

The response

Example: accept

Options: accept, refuse

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/transfer/{id}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "text",
    "response": "accept"
  }'

200

{
  "comment": "text",
  "created": "2025-03-25T05:00:16.425Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-03-25T05:00:16.425Z",
  "status": "pending",
  "subject": {
    "class": "text",
    "id": "text"
  },
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Success

Fetch a transfer request given its identifier

Initiate transfer request

Show child attributes

Show child attributes

Respond to a transfer request