Inhaltsverzeichnis dieser Seite

Funktion

Der Auftragstyp ContactList ermittelt die Daten zu mehreren Kontakten. Das Ergebnis kann über Schlüsselwörter eingegrenzt werden.

Weitere Informationen zum Thema Listenabfragen findest du hier.

Beschreibung

Route: POST /sslcontaxt/{id}

Query-Parameter

Die Daten folgender Schlüsselwörter können mit dem Query-Parameter ?keys[]= abgefragt werden:

  • address
  • city
  • country
  • created
  • email
  • fax
  • fname
  • id
  • lname
  • organization
  • pcode
  • phone
  • state
  • titl
  • updated
Request
{
   "filters": [
      {
         "key": "fname",
         "value": "Sam",
         "operator": "EQUAL",
         "link": "AND",
         "filters": []
      }
   ],
   "view": {
      "limit": 10,
      "offset": 0,
      "children": true,
      "from": "2019-03-01T14:31:33.6306444Z",
      "to": "2019-05-17T14:00:00.6306444Z"
   }
}
Response
{
   "stid": "20190702-app2-dev-24482",
   "status": {
      "code": "S400205",
      "text": "Kontakte wurden erfolgreich ermittelt.",
      "type": "SUCCESS"
   },
   "object": {
      "type": "SslContact",
      "summary": 1
   },
   "data": [
      {
         "created": "2019-07-02T13:12:58.000+0200",
         "updated": "2019-07-02T13:12:58.000+0200",
         "fname": "Max",
         "lname": "Mustermann",
         "organization": "Musterfirma",
         "owner": {
            "context": 9,
            "user": "customer"
         },
         "id": 2058
      }
   ]
}

Auftragstyp-Code: 400205
Verwendet Objekt Contact (SSL_Contact)

Schlüsselwörter

Die Daten folgender Schlüsselwörter können bei Listenabfragen zusätzlich mit dem Schlüsselwort key abgefragt werden:

  • phone
  • email
  • title
  • address
  • postal_code
  • city
  • country
  • state
  • updater
Request
<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <task>
        <code>400205</code>
        <view>
            <limit>10</limit>
            <offset>0</offset>
        </view>
        <where>
            <key>last</key>
            <operator>eq</operator>
            <value>Doe</value>
        </where>
    </task>
</request>
Response
<response>
    <result>
        <data>
            <summary>2</summary>
            <contact>
                <first>Jon</first>
                <last>Doe</last>
                <organization>Organization</organization>
                <owner>
                    <user>USER</user>
                    <context>CONTEXT</context>
                </owner>
                <id>100</id>
                <created>2017-01-02 09:00:00</created>
                <updated>2017-01-02 09:00:00</updated>
            </contact>
            <contact>
                <first>Max</first>
                <last>Doe</last>
                <organization>Musterfirma</organization>
                <owner>
                    <user>USER</user>
                    <context>CONTEXT</context>
                </owner>
                <id>101</id>
                <created>2017-01-02 09:01:00</created>
                <updated>2017-01-02 09:01:00</updated>
            </contact>
        </data>
        <status>
            <code>S400205</code>
			<text>Kontakte wurden erfolgreich ermittelt.</text>
			<type>success</type>
        </status>
    </result>
</response>