Rufen Sie Anerkennungen über die Perform & Engage 365 API ab

Mit der Perform & Engage 365 API können Sie:

• Eine Liste von Anerkennungen abrufen.
• Die Details einer bestimmten Anerkennung anhand ihrer ID abrufen.

Eine Liste von Anerkennungen abrufen

GET /api/v2/recognition/

Mit dieser Anfrage können Sie eine Liste von Anerkennungen abrufen.

Optionale Abfrageparameter

• author_email (String). Die E-Mail-Adresse des Autors der Anerkennung.
• author_name (String). Der vollständige Name des Autors der Anerkennung.
• mentioned_email (String). Die E-Mail-Adresse des Mitarbeiters, der in der Anerkennung erwähnt wird.
• mentioned_name (String). Der vollständige Name des in der Anerkennung erwähnten Mitarbeiters.
• limit (Integer). Die maximale Anzahl von Anerkennungen in der Antwort.
• offset (Integer). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispielanfrage

GET /api/v2/recognition/?author_name=Leslie%20Davies&
mentioned_name=Raymond%20Armstrong

Parameter des Antworttexts

Der Antworttext enthält:

• count (Integer). Die Anzahl der Ergebnisse.
• next und previous (Strings). URLs zu den nächsten und vorherigen Seiten (wenn Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (Array). Die Liste der Recognition-Objekte. Jede Anerkennung hat diese Parameter:
  • api_id (String). Die Recognition-ID. Sie können diese ID verwenden, um weitere Details zur Recognition abzurufen.
  • question_api_id (String). Die Question-ID. Sie können diese ID verwenden, um weitere Details zur Question abzurufen.
  • question_text (String). Der Question-Text.
  • response_api_id (String). Die Response-ID. Sie können diese ID verwenden, um weitere Details zur Response abzurufen.
  • response_text (String). Der Response-Text.
  • author_api_id (String). Die ID des Autors der Recognition.
  • author_name (String). Der vollständige Name des Autors der Recognition.
  • author_email (String). Die E-Mail-Adresse des Autors der Recognition.
  • mentioned_api_id (string). Die ID des in der Antwort erwähnten Mitarbeiters.
  • mentioned_name (string). Vollständiger Name des in der Anerkennung erwähnten Mitarbeiters.
  • mentioned_email (string). Die E-Mail-Adresse des in der Anerkennung erwähnten Mitarbeiters.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort gibt einen Antworttext zurück, der etwa so aussieht:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:792db414-5369-4364-86a2-7fd572e9ba4f",
     "question_api_id": "580:9e5a1d83-a22d-4673-91a9-6d17d723ab71",
     "question_text": "Hat jemand diese Woche großartige Arbeit geleistet?" ",
     "response_api_id": "580:13728691-a484-4bdb-83cf-05977af05fc2",
     "response_text": "@(Raymond Armstrong) und @(Mohammed Bennett) 
     haben diese Woche beide wirklich gute Arbeit geleistet, indem sie mir bei allen laufenden Kampagnenaktivitäten geholfen haben.",
     "author_api_id": "580:e42eda47-8818-45b1-8d89-8b8b92bc9559",
     "author_name": "Leslie Davies",
     "author_email": "contact+LeslieDavies@weekly10.net",
     "mentioned_api_id": "580:2bad1838-8b72-4ceb-b1d5-cee795b94b7e",
     "mentioned_name": "Raymond Armstrong",
     "mentioned_email": "contact+RaymondArmstrong@weekly10.net"
   }
]
}

Details zu einer bestimmten Anerkennung über ihre ID abrufen

GET api/v2/recognition/{api_id}/

Nachdem Sie die Anerkennungs-api_id in der Antwort auf die zurückliegende Anfrage erhalten haben, können Sie diese ID verwenden, um Informationen zur Anerkennung abzurufen.

Erforderlicher Pfadparameter

• api_id (string). Die Anerkennungs-ID, die Sie erhalten, indem Sie die GET-Anfrage /api/v2/recognition/ senden.

Anfragebeispiel

GET /api/v2/questions/580%3A396cd5f1-d52b-4cfc-bcc6-610e17697a86

Parameter im Antworttext

Die Antwort auf GET api/v2/recognition/{api_id}/ enthält dieselben Parameter wie das results-Array in der Antwort auf GET /api/v2/recognition/.

Beispiel für den Antworttext

Die erfolgreiche 200-Antwort gibt einen Antworttext zurück, der etwa so aussieht:

{
 "api_id": "580:792db414-5369-4364-86a2-7fd572e9ba4f",
 "question_api_id": "580:9e5a1d83-a22d-4673-91a9-6d17d723ab71",
 "question_text": "Hat jemand diese Woche großartige Arbeit geleistet?" ",
 "response_api_id": "580:13728691-a484-4bdb-83cf-05977af05fc2",
 "response_text": "@(Raymond Armstrong) und @(Mohammed Bennett) 
 haben diese Woche beide wirklich gute Arbeit geleistet, indem sie mir bei allen laufenden Kampagnenaktivitäten geholfen haben.",
 "author_api_id": "580:e42eda47-8818-45b1-8d89-8b8b92bc9559",
 "author_name": "Leslie Davies",
 "author_email": "contact+LeslieDavies@weekly10.net",
 "mentioned_api_id": "580:2bad1838-8b72-4ceb-b1d5-cee795b94b7e",
 "mentioned_name": "Raymond Armstrong",
 "mentioned_email": "contact+RaymondArmstrong@weekly10.net"
}