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

Paramètres de chemin

idanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

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

200

Success

{
  "comment": "text",
  "created": "2025-05-27T16:38:53.958Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-05-27T16:38:53.958Z",
  "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"
  }
}

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/transfer/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "comment": "text",
    "created": "2025-05-27T16:38:53.958Z",
    "id": "text",
    "owner": {
      "class": "text",
      "id": "text"
    },
    "recipient": {
      "class": "text",
      "id": "text"
    },
    "reponse_comment": "text",
    "responded": "2025-05-27T16:38:53.958Z",
    "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

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

commentstringRequis

An explanation about the transfer request

recipientall ofRequis

The transfer recipient, either an user or an organization

subjectall ofRequis

The transfered subject

Réponses

200

Success

application/json

post

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

{
  "comment": "text",
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "subject": {
    "class": "text",
    "id": "text"
  }
}

200

Success

{
  "comment": "text",
  "created": "2025-05-27T16:38:53.958Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-05-27T16:38:53.958Z",
  "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

Paramètres de chemin

idanyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

commentstringOptionnel

An optional comment about the transfer response

responsestring · enumRequis

The response

Example: acceptValeurs possibles:

Réponses

200

Success

application/json

post

POST /api/1/transfer/{id}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "comment": "text",
  "response": "accept"
}

200

Success

{
  "comment": "text",
  "created": "2025-05-27T16:38:53.958Z",
  "id": "text",
  "owner": {
    "class": "text",
    "id": "text"
  },
  "recipient": {
    "class": "text",
    "id": "text"
  },
  "reponse_comment": "text",
  "responded": "2025-05-27T16:38:53.958Z",
  "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"
  }
}