transfer

get

/transfer/

Header parameters
X-Fieldsstring mask

An optional fields mask

Responses
curl -L \
  --url '//www.data.gouv.fr/api/1/transfer/'
[
  {
    "comment": "text",
    "created": "2025-02-07T18:37:10.622Z",
    "id": "text",
    "owner": {
      "class": "text",
      "id": "text"
    },
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "reponse_comment": "text",
    "responded": "2025-02-07T18:37:10.622Z",
    "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"
    }
  }
]

Initiate transfer request

post

/transfer/

Header parameters
X-Fieldsstring mask

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
curl -L \
  --request POST \
  --url '//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"}}'
{
  "comment": "text",
  "created": "2025-02-07T18:37:10.622Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-02-07T18:37:10.622Z",
  "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"
  }
}

Fetch a transfer request given its identifier

get

/transfer/{id}//

Path parameters
idstringrequired
Header parameters
X-Fieldsstring mask

An optional fields mask

Responses
curl -L \
  --url '//www.data.gouv.fr/api/1/transfer/{id}/'
{
  "comment": "text",
  "created": "2025-02-07T18:37:10.622Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-02-07T18:37:10.622Z",
  "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"
  }
}

Respond to a transfer request

post

/transfer/{id}//

Path parameters
idstringrequired
Header parameters
X-Fieldsstring mask

An optional fields mask

Body
commentstring

An optional comment about the transfer response

responseenumrequired

The response

Example: accept
Options: accept, refuse
Responses
curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/transfer/{id}/' \
  --header 'Content-Type: application/json' \
  --data '{"response":"accept"}'
{
  "comment": "text",
  "created": "2025-02-07T18:37:10.622Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-02-07T18:37:10.622Z",
  "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"
  }
}

Dernière mise à jour

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