Kontaktwege ändern

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Hinweise zur Funktion

Eine Person kann über mehrere Kommunikationswege verfügen. Wenn Sie einen neuen Kommunikationsweg erfassen, wird der alte Kommunikationsweg hierdurch nicht automatisch ungültig.

Im Gegensatz zu Adressen können die Kontaktwege nicht mit einem Ablaufdatum versehen werden. Wenn ein Kontaktweg nicht länger verwendet werden darf, muss dieser entweder gelöscht werden, oder eine dazugehörige Anschrift muss über das Ablaufdatum für ungültig erklärt werden.

Bitte beachten Sie, dass ein Kontaktweg selbst bei einer ungültigen Anschrift noch angezeigt wird. Betrachten Sie einen Kontaktweg mit einer zugeordneten Anschrift deshalb immer im Kontext der Gültigkeit der zugeordneten Anschrift.

Neue Kommunikationswege erfassen

Version 1.0

---

post

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

CommunicationTypeIdinteger · int32Optional

RelatedAddressIdinteger · int32 | nullfähigOptional

Contentstring | nullfähigOptional

Explanationstring | nullfähigOptional

Antworten

201

Created

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.0/PersonsWrite/Person/{personId}/Communications

HTTPcURLJavaScriptPython

POST /openwowi/v1.0/PersonsWrite/Person/{personId}/Communications HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "CommunicationTypeId": 1,
  "RelatedAddressId": 1,
  "Content": "text",
  "Explanation": "text"
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

post

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

CommunicationTypeIdinteger · int32Optional

RelatedAddressIdinteger · int32 | nullfähigOptional

Contentstring | nullfähigOptional

Explanationstring | nullfähigOptional

Antworten

201

Created

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.2/PersonsWrite/Person/{personId}/Communications

HTTPcURLJavaScriptPython

POST /openwowi/v1.2/PersonsWrite/Person/{personId}/Communications HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "CommunicationTypeId": 1,
  "RelatedAddressId": 1,
  "Content": "text",
  "Explanation": "text"
}

application/jsontext/jsonapplication/*+json

1

---

Bestehende Kommunikationswege ändern

Version 1.0

---

put

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

childIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

CommunicationTypeIdinteger · int32Optional

RelatedAddressIdinteger · int32 | nullfähigOptional

Contentstring | nullfähigOptional

Explanationstring | nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.0/PersonsWrite/Person/{personId}/Communications/{childId}

HTTPcURLJavaScriptPython

PUT /openwowi/v1.0/PersonsWrite/Person/{personId}/Communications/{childId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "CommunicationTypeId": 1,
  "RelatedAddressId": 1,
  "Content": "text",
  "Explanation": "text"
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

put

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

childIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

CommunicationTypeIdinteger · int32Optional

RelatedAddressIdinteger · int32 | nullfähigOptional

Contentstring | nullfähigOptional

Explanationstring | nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.2/PersonsWrite/Person/{personId}/Communications/{childId}

HTTPcURLJavaScriptPython

PUT /openwowi/v1.2/PersonsWrite/Person/{personId}/Communications/{childId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "CommunicationTypeId": 1,
  "RelatedAddressId": 1,
  "Content": "text",
  "Explanation": "text"
}

application/jsontext/jsonapplication/*+json

1

---

Bestehende Kommunikationswege löschen

Version 1.0

---

delete

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

childIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

/openwowi/v1.0/PersonsWrite/Person/{personId}/Communications/{childId}

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.0/PersonsWrite/Person/{personId}/Communications/{childId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

1

---

Version 1.2

---

delete

Autorisierungen

Authorization

Pfadparameter

personIdinteger · int32Erforderlich

childIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

/openwowi/v1.2/PersonsWrite/Person/{personId}/Communications/{childId}

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.2/PersonsWrite/Person/{personId}/Communications/{childId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

1

---