---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Verbraucher-API

# Verbraucher-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 13 Minuten Lesedauer

Die Verbraucher Die API stellt Endpunkte zum Abrufen und Aktualisieren bereit Kundenservice-Management (CSM)Verbraucherdatensätze.
Darüber hinaus können Sie beim Erstellen eines Verbrauchers neue Social Media-Profildatensätze generieren.

Die Verbraucher API erfordert das Kundenservice-Plugin (com.sn_customerservice) und wird in bereitgestellt `Jetzt `Namespace.

Anwender benötigen die Rolle „csm_WS_Integration" für vollständigen API-Zugriff.

## Verbraucher -- GET /now/Consumer {#ariaid-title2}

Ruft einen angegebenen Satz von ab Kundenservice-Management (CSM)Verbraucherdatensätze.

### URL-Format

Versionierte URL: /api/now/{api_Version}/Consumer

Standard-URL: /api/now/Consumer  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#consumer-GET__entry__2}{#consumer-GET__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#consumer-GET__entry__6}{#consumer-GET__sysparm-limit-entry}{#consumer-GET__sysparm-offset-entry}{#consumer-GET__sysparm-query-entry}

| Name | Beschreibung |
|-|-|
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. In der Antwort der boolesche Parameter hasMoreWird zurückgegeben. Gibt an, ob weitere zurückzugebende Datensätze vorhanden sind, die die Filterkriterien erfüllen. Datentyp: Zahl Standard: 10 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0" festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie `Sysparm_Offset=sysparm_Offset+sysparm_limit `, Bis Sie das Ende aller Datensätze erreichen. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet wird. Zum Beispiel: `Sysparm_query=caller_ID=javascript:gs.getUserID()^Active=wahr` Die codierte Abfrage unterstützt Sortieren nach . Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie SORTIEREN NACH Und ORDERBYDESC Klauseln in sysparm_query. Beispiel: `Sysparm_query=Active=wahr^ORDERBYNummer^ORDERBYDESCCATEGORY `Filtert alle aktiven Datensätze und ordnet die Ergebnisse zuerst in aufsteigender Reihenfolge nach Zahl und dann in absteigender Reihenfolge nach Kategorie an. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Sie können dieses Verhalten mithilfe der Eigenschaft steuern glide.invalid_query.returns_no_rows. Legen Sie diese Eigenschaft auf „wahr" fest, um keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
[Tabelle : 2. Abfrageparameter]

{#consumer-GET__entry__14}

| Element | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-GET__entry__18}{#consumer-GET__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#consumer-GET__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-GET__entry__26}{#consumer-GET__entry-200-status-code}{#consumer-GET__entry-401-status-code}{#consumer-GET__entry-404-status-code}{#consumer-GET__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle anwenderdefinierten Felder zurück, die der Tabelle Verbraucher \[csm_Consumer\] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition \[SystemdefinitionTabellen\].
{#consumer-GET__csmconsumer_response_parms__entry__2}{#consumer-GET__consumertable-active-entry}{#consumer-GET__consumertable-business_phone-entry}{#consumer-GET__consumertable-city-entry}{#consumer-GET__consumertable-country-entry}{#consumer-GET__consumertable-date_format-entry}{#consumer-GET__consumertable-email-entry}{#consumer-GET__consumertable-fax-entry}{#consumer-GET__consumertable-first_name-entry}{#consumer-GET__consumertable-gender-entry}{#consumer-GET__consumertable-home_phone-entry}{#consumer-GET__consumertable-household-entry}{#consumer-GET__consumertable-last_name-entry}{#consumer-GET__consumertable-middle_name-entry}{#consumer-GET__consumertable-mobile_phone-entry}{#consumer-GET__consumertable-name-entry}{#consumer-GET__consumertable-notes-entry}{#consumer-GET__consumertable-notification-entry}{#consumer-GET__consumertable-number-entry}{#consumer-GET__consumertable-photo-entry}{#consumer-GET__consumertable-preferred_language-entry}{#consumer-GET__consumertable-prefix-entry}{#consumer-GET__consumertable-primary-entry}{#consumer-GET__consumertable-state-entry}{#consumer-GET__consumertable-street-entry}{#consumer-GET__consumertable-suffix-entry}{#consumer-GET__consumertable-sys_created_by-entry}{#consumer-GET__consumertable-sys_created_on-entry}{#consumer-GET__consumertable-sys_domain-entry}{#consumer-GET__consumertable-sys_id-entry}{#consumer-GET__consumertable-sys_mod_count-entry}{#consumer-GET__consumertable-sys_updated_by-entry}{#consumer-GET__consumertable-sys_updated_on-entry}{#consumer-GET__consumertable-time_format-entry}{#consumer-GET__consumertable-time_zone-entry}{#consumer-GET__consumertable-title-entry}{#consumer-GET__consumertable-user-entry}{#consumer-GET__consumertable-zip-entry}

| Element | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist. Mögliche Werte: * Wahr: Verbraucher aktiv * Falsch: Verbraucher deaktiviert {#consumer-GET__ul_asy_4b3_2hb} Datentyp: Boolescher Wert Standard: Wahr |
| business_phone | Geschäftliche Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| city | Stadt, in der der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| country | Land, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Datum_Format | Format, in dem Daten angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-GET__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| E-Mail | E-Mail-Adresse des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Fax | Faxnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Geschlecht des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| home_phone | Private Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Haushalt | SYS_ID des Datensatzes, der die Haushaltsmerkmale beschreibt. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| last_name | Nachname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Middle_Name | Zweiter Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| name | Vollständiger Verbrauchername; first_Name+Middle_Name+Last_Name. Datentyp: Zeichenfolge Maximale Länge: 152 |
| Notizen | Hinweise zum Verbraucher. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-GET__ul_o5d_pyh_2hb} Datentyp: Zahl (Ganzzahl) Maximale Länge: 40 Standard: 2 |
| Nummer | Eindeutige Nummer, die dem Verbraucher zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Foto | Foto des Verbrauchers. Datentyp: Bild |
| Preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Präfix | Verbrauchernamenpräfix, z. B. Dr., Herr, Frau oder Frau Datentyp: Zeichenfolge Maximale Länge: 40 |
| primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * Wahr: Primärer Verbraucher * Falsch: Kein primärer Verbraucher {#consumer-GET__ul_yns_yb3_2hb} Datentyp: Boolescher Wert Standard: Falsch |
| Staat | Status, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Straße | Straße und Hausnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Suffix | Verbrauchernamenssuffix wie „Jr.", „SR" oder „II" Datentyp: Zeichenfolge |
| sys_created_by | Anwender, der den Verbraucherdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Verbraucherdatensatzes. Datentyp: Zeichenfolge |
| sys_Domain | ServiceNow Domäne, in der sich die Verbraucherinformationen befinden. Datentyp: Zeichenfolge |
| sys_id | Eindeutiger Bezeichner für den Verbraucher. Datentyp: Zeichenfolge |
| sys_mod_count | Gibt an, wie oft die zugehörigen Verbraucherinformationen geändert wurden. Datentyp: Zahl (Ganzzahl) |
| sys_Tags | System-Tags. Datentyp: Zeichenfolge |
| sys_updated_by | Anwender, der die Verbraucherinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Verbraucherinformationen. Datentyp: Zeichenfolge |
| Time_Format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss A: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-GET__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| Time_Zone | Verbraucherzeitzone, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| Anwender | SYS_ID des Verbraucheranwenders. Datentyp: Zeichenfolge Tabelle: Verbraucheranwender \[csm_Consumer_user\] |
| Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
[ ]

### Curl-Anforderung

    curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": [
        {
          "country": "USA",
          "notes": "",
          "gender": "Male",
          "city": "Plano",
          "prefix": "",
          "sys_updated_on": "2016-08-12 00:19:12",
          "suffix": "",
          "title": "",
          "number": "CSMR0000004",
          "notification": "2",
          "sys_id": "01d8403fdb1b1200b6075200cf961941",
          "business_phone": "",
          "sys_updated_by": "prithvi",
          "mobile_phone": "",
          "street": "6900 Dallas Pkwy",
          "sys_created_on": "2016-06-16 19:20:13",
          "sys_domain": "global",
          "state": "TX",
          "fax": "",
          "first_name": "Harding",
          "email": "harding.asher@mailinator.com",
          "preferred_language": "",
          "sys_created_by": "guest",
          "zip": "75024",
          "home_phone": "",
          "time_format": "",
          "sys_mod_count": "8",
          "last_name": "Asher",
          "photo": "",
          "active": "true",
          "middle_name": "",
          "time_zone": "",
          "sys_tags": "",
          "name": "Harding Asher",
          "household": "",
          "date_format": "",
          "user": "c3d35d82c37122005871d44d81d3ae91",
          "primary": "false"
        },
        {
          "country": "USA",
          "notes": "",
          "gender": "Male",
          "city": "San Francisco",
          "prefix": "",
          "sys_updated_on": "2016-08-12 00:20:27",
          "suffix": "",
          "title": "",
          "number": "CSMR0000002",
          "notification": "2",
          "sys_id": "a0488cfbdb1b1200b6075200cf9619db",
          "business_phone": "",
          "sys_updated_by": "prithvi",
          "mobile_phone": "",
          "street": "144 2nd St",
          "sys_created_on": "2016-06-16 19:17:44",
          "sys_domain": "global",
          "state": "CA",
          "fax": "",
          "first_name": "Sam",
          "email": "sam.collins@mailinator.com",
          "preferred_language": "",
          "sys_created_by": "guest",
          "zip": "94105",
          "home_phone": "",
          "time_format": "",
          "sys_mod_count": "13",
          "last_name": "Collins",
          "photo": "",
          "active": "true",
          "middle_name": "",
          "time_zone": "",
          "sys_tags": "",
          "name": "Sam Collins",
          "household": "",
          "date_format": "",
          "user": "64488cfbdb1b1200b6075200cf9619db",
          "primary": "false"
        }
      ]
    }

## Verbraucher -- GET /now/Consumer/{ID} {#ariaid-title3}

Ruft die angegebene ab Kundenservice-Management (CSM)Verbraucherdatensatz.

### URL-Format

Versionierte URL: /api/now/{api_Version}/Consumer/{ID}

Standard-URL: /api/now/Consumer/{ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#consumer-GET-id__entry__2}{#consumer-GET-id__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| ID | SYS_ID des zurückzugebenden Verbraucherdatensatzes. Datentyp: Zeichenfolge Tabelle: Verbraucher \[csm_Consumer\] |
[Tabelle : 7. Pfad-Parameter]

{#consumer-GET-id__entry__8}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Abfrageparameter]

{#consumer-GET-id__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-GET-id__entry__16}{#consumer-GET-id__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen.]

{#consumer-GET-id__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-GET-id__entry__24}{#consumer-GET-id__entry-200-status-code}{#consumer-GET-id__entry-401-status-code}{#consumer-GET-id__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Gibt an, dass die Anforderung ungültig ist. Dies kann aus einem der folgenden Gründe liegen: * Angeforderter Fall ist nicht vorhanden. * Anwender hat keinen Zugriff auf den Verbraucherdatensatz. {#consumer-GET-id__ul_ubm_1jl_3v} |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle anwenderdefinierten Felder zurück, die der Tabelle Verbraucher \[csm_Consumer\] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition \[SystemdefinitionTabellen\].
{#consumer-GET-id__csmconsumer_response_parms__entry__2}{#consumer-GET-id__consumertable-active-entry}{#consumer-GET-id__consumertable-business_phone-entry}{#consumer-GET-id__consumertable-city-entry}{#consumer-GET-id__consumertable-country-entry}{#consumer-GET-id__consumertable-date_format-entry}{#consumer-GET-id__consumertable-email-entry}{#consumer-GET-id__consumertable-fax-entry}{#consumer-GET-id__consumertable-first_name-entry}{#consumer-GET-id__consumertable-gender-entry}{#consumer-GET-id__consumertable-home_phone-entry}{#consumer-GET-id__consumertable-household-entry}{#consumer-GET-id__consumertable-last_name-entry}{#consumer-GET-id__consumertable-middle_name-entry}{#consumer-GET-id__consumertable-mobile_phone-entry}{#consumer-GET-id__consumertable-name-entry}{#consumer-GET-id__consumertable-notes-entry}{#consumer-GET-id__consumertable-notification-entry}{#consumer-GET-id__consumertable-number-entry}{#consumer-GET-id__consumertable-photo-entry}{#consumer-GET-id__consumertable-preferred_language-entry}{#consumer-GET-id__consumertable-prefix-entry}{#consumer-GET-id__consumertable-primary-entry}{#consumer-GET-id__consumertable-state-entry}{#consumer-GET-id__consumertable-street-entry}{#consumer-GET-id__consumertable-suffix-entry}{#consumer-GET-id__consumertable-sys_created_by-entry}{#consumer-GET-id__consumertable-sys_created_on-entry}{#consumer-GET-id__consumertable-sys_domain-entry}{#consumer-GET-id__consumertable-sys_id-entry}{#consumer-GET-id__consumertable-sys_mod_count-entry}{#consumer-GET-id__consumertable-sys_updated_by-entry}{#consumer-GET-id__consumertable-sys_updated_on-entry}{#consumer-GET-id__consumertable-time_format-entry}{#consumer-GET-id__consumertable-time_zone-entry}{#consumer-GET-id__consumertable-title-entry}{#consumer-GET-id__consumertable-user-entry}{#consumer-GET-id__consumertable-zip-entry}

| Element | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist. Mögliche Werte: * Wahr: Verbraucher aktiv * Falsch: Verbraucher deaktiviert {#consumer-GET-id__ul_asy_4b3_2hb} Datentyp: Boolescher Wert Standard: Wahr |
| business_phone | Geschäftliche Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| city | Stadt, in der der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| country | Land, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Datum_Format | Format, in dem Daten angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-GET-id__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| E-Mail | E-Mail-Adresse des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Fax | Faxnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Geschlecht des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| home_phone | Private Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Haushalt | SYS_ID des Datensatzes, der die Haushaltsmerkmale beschreibt. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| last_name | Nachname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Middle_Name | Zweiter Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| name | Vollständiger Verbrauchername; first_Name+Middle_Name+Last_Name. Datentyp: Zeichenfolge Maximale Länge: 152 |
| Notizen | Hinweise zum Verbraucher. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-GET-id__ul_o5d_pyh_2hb} Datentyp: Zahl (Ganzzahl) Maximale Länge: 40 Standard: 2 |
| Nummer | Eindeutige Nummer, die dem Verbraucher zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Foto | Foto des Verbrauchers. Datentyp: Bild |
| Preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Präfix | Verbrauchernamenpräfix, z. B. Dr., Herr, Frau oder Frau Datentyp: Zeichenfolge Maximale Länge: 40 |
| primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * Wahr: Primärer Verbraucher * Falsch: Kein primärer Verbraucher {#consumer-GET-id__ul_yns_yb3_2hb} Datentyp: Boolescher Wert Standard: Falsch |
| Staat | Status, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Straße | Straße und Hausnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Suffix | Verbrauchernamenssuffix wie „Jr.", „SR" oder „II" Datentyp: Zeichenfolge |
| sys_created_by | Anwender, der den Verbraucherdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Verbraucherdatensatzes. Datentyp: Zeichenfolge |
| sys_Domain | ServiceNow Domäne, in der sich die Verbraucherinformationen befinden. Datentyp: Zeichenfolge |
| sys_id | Eindeutiger Bezeichner für den Verbraucher. Datentyp: Zeichenfolge |
| sys_mod_count | Gibt an, wie oft die zugehörigen Verbraucherinformationen geändert wurden. Datentyp: Zahl (Ganzzahl) |
| sys_updated_by | Anwender, der die Verbraucherinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Verbraucherinformationen. Datentyp: Zeichenfolge |
| Time_Format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss A: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-GET-id__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| Time_Zone | Verbraucherzeitzone, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| Anwender | SYS_ID des Verbraucheranwenders. Datentyp: Zeichenfolge Tabelle: Verbraucheranwender \[csm_Consumer_user\] |
| Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
[ ]

### Curl-Anforderung

    curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": {
        "country": "USA",
        "notes": "",
        "gender": "Male",
        "city": "Plano",
        "prefix": "",
        "sys_updated_on": "2016-08-12 00:19:12",
        "suffix": "",
        "title": "",
        "number": "CSMR0000004",
        "notification": "2",
        "sys_id": "01d8403fdb1b1200b6075200cf961941",
        "business_phone": "",
        "sys_updated_by": "prithvi",
        "mobile_phone": "",
        "street": "6900 Dallas Pkwy",
        "sys_created_on": "2016-06-16 19:20:13",
        "sys_domain": "global",
        "state": "TX",
        "fax": "",
        "first_name": "Harding",
        "email": "harding.asher@mailinator.com",
        "preferred_language": "",
        "sys_created_by": "guest",
        "zip": "75024",
        "home_phone": "",
        "time_format": "",
        "sys_mod_count": "8",
        "last_name": "Asher",
        "photo": "",
        "active": "true",
        "middle_name": "",
        "time_zone": "",
        "sys_tags": "",
        "name": "Harding Asher",
        "household": "",
        "date_format": "",
        "user": "c3d35d82c37122005871d44d81d3ae91",
        "primary": "false"
      }
    }

## Verbraucher -- POST /now/Consumer {#ariaid-title4}

Erstellt eine neue Kundenservice-Management (CSM)Verbraucher.
Darüber hinaus können Sie mithilfe dieses Endpunkts ein Social Media-Profil für den Verbraucher erstellen. Um das Profil zu erstellen, müssen Sie die folgenden Parameter im Anforderungstext angeben:

* social_channel
* social_handle
* social_handle_url
{#consumer-POST__ul_ntx_lg4_pgb}  
Warnung:  
Dieser Endpunkt führt keine Parametervalidierung durch, da dies zu einem übermäßigen Overhead führen kann. Wenn ein Anforderungsparameter falsch geschrieben ist, ungültig ist oder vom Endpunkt nicht unterstützt wird, wird er ohne Warnung ignoriert.

### URL-Format

Versionierte URL: /api/now/{api_Version}/Consumer

Standard-URL: /api/now/Consumer  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#consumer-POST__entry__2}{#consumer-POST__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 13. Pfad-Parameter]

{#consumer-POST__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 14. Abfrageparameter]

{#consumer-POST__entry__10}{#consumer-POST__consumertable-active-entry}{#consumer-POST__consumertable-business_phone-entry}{#consumer-POST__consumertable-city-entry}{#consumer-POST__consumertable-country-entry}{#consumer-POST__consumertable-date_format-entry}{#consumer-POST__consumertable-email-entry}{#consumer-POST__consumertable-fax-entry}{#consumer-POST__consumertable-first_name-entry}{#consumer-POST__consumertable-gender-entry}{#consumer-POST__consumertable-home_phone-entry}{#consumer-POST__consumertable-household-entry}{#consumer-POST__consumertable-last_name-entry}{#consumer-POST__consumertable-middle_name-entry}{#consumer-POST__consumertable-mobile_phone-entry}{#consumer-POST__consumertable-name-entry}{#consumer-POST__consumertable-notes-entry}{#consumer-POST__consumertable-notification-entry}{#consumer-POST__consumertable-photo-entry}{#consumer-POST__consumertable-preferred_language-entry}{#consumer-POST__consumertable-prefix-entry}{#consumer-POST__consumertable-primary-entry}{#consumer-POST__consumertable-state-entry}{#consumer-POST__consumertable-street-entry}{#consumer-POST__consumertable-suffix-entry}{#consumer-POST__consumertable-time_format-entry}{#consumer-POST__consumertable-time_zone-entry}{#consumer-POST__consumertable-title-entry}{#consumer-POST__consumertable-user-entry}{#consumer-POST__consumertable-zip-entry}

| Element | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist. Mögliche Werte: * Wahr: Verbraucher aktiv * Falsch: Verbraucher deaktiviert {#consumer-POST__ul_asy_4b3_2hb} Datentyp: Boolescher Wert Standard: Wahr |
| business_phone | Geschäftliche Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| city | Stadt, in der der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| country | Land, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Datum_Format | Format, in dem Daten angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-POST__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| E-Mail | E-Mail-Adresse des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Fax | Faxnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Geschlecht des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| home_phone | Private Telefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Haushalt | SYS_ID des Datensatzes, der die Haushaltsmerkmale beschreibt. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| last_name | Nachname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Middle_Name | Zweiter Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
| name | Vollständiger Verbrauchername; first_Name+Middle_Name+Last_Name. Datentyp: Zeichenfolge Maximale Länge: 152 |
| Notizen | Hinweise zum Verbraucher. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-POST__ul_o5d_pyh_2hb} Datentyp: Zahl (Ganzzahl) Maximale Länge: 40 Standard: 2 |
| Foto | Foto des Verbrauchers. Datentyp: Bild |
| Preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Präfix | Verbrauchernamenpräfix, z. B. Dr., Herr, Frau oder Frau Datentyp: Zeichenfolge Maximale Länge: 40 |
| primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * Wahr: Primärer Verbraucher * Falsch: Kein primärer Verbraucher {#consumer-POST__ul_yns_yb3_2hb} Datentyp: Boolescher Wert Standard: Falsch |
| Social_Channel | Social Media-Kanal, dem der Verbraucher zugeordnet ist, z. B. Twitter, Facebook oder Instagram. Datentyp: Zeichenfolge |
| Social_Handle | Anwender-Handle im Social Media-Kanal. Datentyp: Zeichenfolge |
| Social_Handle_url | URL zum Handle des sozialen Kanals des Verbrauchers. Datentyp: Zeichenfolge |
| Staat | Status, in dem der Verbraucher wohnt. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Straße | Straße und Hausnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Suffix | Verbrauchernamenssuffix wie „Jr.", „SR" oder „II" Datentyp: Zeichenfolge |
| Time_Format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss A: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-POST__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| Time_Zone | Verbraucherzeitzone, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| Anwender | SYS_ID des Verbraucheranwenders. Datentyp: Zeichenfolge Tabelle: Verbraucheranwender \[csm_Consumer_user\] |
| Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 |
[Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-POST__entry__76}{#consumer-POST__accept-JSON-only-entry-RESTAPI}{#consumer-POST__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 16. Anforderungskopfzeilen.]

{#consumer-POST__entry__82}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#consumer-POST__entry__86}{#consumer-POST__entry-401-status-code}

| Statuscode | Beschreibung |
|-|-|
| 201 | Neuer Verbraucherdatensatz wurde erfolgreich erstellt. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
[Tabelle : 18. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#consumer-POST__entry__96}

| Element | Beschreibung |
|-|-|
| Ergebnis | SYS_ID des neu erstellten Verbraucherdatensatzes. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

    curl -X POST "https://instance.servicenow.com/api/now/consumer" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d " { \
      "country": "USA", \
      "notes": "Never comes in before 10am", \
      "gender": "Female", \
      "city": "San Marcos", \
      "prefix": "Ms", \
      "title": "Director", \
      "notification": "1", \
      "business_phone": "(555)555-1234", \
      "mobile_phone": "(555)555-1235", \
      "street": "123 Sesame St", \
      "state": "CA", \
      "fax": "(555)555-1236", \
      "first_name": "Jane", \
      "zip": "92001", \
      "home_phone": "(555)555-1234", \
      "last_name": "Brown", \
      "active": "true", \
      "middle_name": "Dell", \
      "time_zone": "PST", \
      "name": "Jane Brown", \
      "household": "4", \
      "user": "c3d35d82c37122005871d44d81d3ae91", \
      "primary": "false" \
    }"
    --user "username":"password"

    {
        "result": "0f5c13addb93230057c3fd441d9619b8"
    }


