| GET | /client/ClientPerson/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| OrganisationId | form | long? | No | |
| Forename | form | string | No | |
| Lastname | form | string | No | |
| Birthday | form | DateTime? | No | |
| Notes | form | string | No | |
| PersonTyp | form | int | No | |
| CareLevel | form | CareLevel | No | |
| CareLevelDate | form | DateTime? | No | |
| PhoneNumber | form | string | No | |
| form | string | No | ||
| Mobile | form | string | No | |
| Gender | form | int | No | |
| SearchForTrainedHelper | form | bool | No | |
| Gendertype | form | Gender | No | |
| Relationshipstatus | form | Relationshipstatus | No | |
| GeographicalFrame | form | int | No | |
| Deleted | form | bool | No | |
| PicLink | form | string | No | |
| BlobPicLink | form | string | No | |
| Address | form | ClientAddressResponse | No | |
| User | form | ClientUserResponse | No | |
| FullMonthlyCapacity | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| PersonHelperTyp | form | PersonHelperType | No | |
| Fax | form | string | No | |
| PinDesiredHours | form | decimal | No | |
| Salutation | form | Salutation | No | |
| Title | form | Title | No | |
| AttentivelyBy | form | AttentivelyBy | No | |
| Iban | form | string | No | |
| BIC | form | string | No | |
| AlternativeAccountHolder | form | string | No | |
| CreditInstitution | form | string | No | |
| PaymentTypeId | form | long | No | |
| SepaMandateReferenceNumber | form | string | No | |
| ReasonForPayment | form | bool | No | |
| PaymentRecipient | form | string | No | |
| CreditorIdent | form | string | No | |
| WantsDementialLecture | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| PersonId | form | long | No | |
| Street | form | string | No | |
| BuildingNo | form | string | No | |
| PostCode | form | string | No | |
| District | form | string | No | |
| City | form | string | No | |
| Latitude | form | double | No | |
| Longitude | form | double | No | |
| AddressSupplement | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| form | string | No | ||
| Password | form | string | No | |
| IsAdministrator | form | bool | No | |
| IsSuperAdmin | form | bool | No | |
| PersonId | form | long | No | |
| IsClient | form | bool | No | |
| UserVerified | form | bool | No | |
| UserUnlocked | form | bool | No | |
| IsDeleted | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /client/ClientPerson/{Id} HTTP/1.1
Host: api.helferportal.de
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
AccountId: 0,
OrganisationId: 0,
Forename: String,
Lastname: String,
Birthday: 0001-01-01,
Notes: String,
PersonTyp: 0,
CareLevel: NoCarelevel,
CareLevelDate: 0001-01-01,
PhoneNumber: String,
EMail: String,
Mobile: String,
Gender: 0,
SearchForTrainedHelper: False,
Gendertype: male,
Relationshipstatus: NotAvailable,
GeographicalFrame: 0,
Deleted: False,
PicLink: String,
BlobPicLink: String,
Address:
{
Id: 0,
AccountId: 0,
PersonId: 0,
Street: String,
BuildingNo: String,
PostCode: String,
District: String,
City: String,
Latitude: 0,
Longitude: 0,
AddressSupplement: String
},
User:
{
Id: 0,
AccountId: 0,
EMail: String,
Password: String,
IsAdministrator: False,
IsSuperAdmin: False,
PersonId: 0,
IsClient: False,
UserVerified: False,
UserUnlocked: False,
IsDeleted: False
},
FullMonthlyCapacity: False,
FilterOnLanguages:
[
0
],
PersonHelperTyp: EverydayHelper,
Fax: String,
PinDesiredHours: 0,
Salutation: None,
Title: None,
AttentivelyBy: Default,
Iban: String,
BIC: String,
AlternativeAccountHolder: String,
CreditInstitution: String,
PaymentTypeId: 0,
SepaMandateReferenceNumber: String,
ReasonForPayment: False,
PaymentRecipient: String,
CreditorIdent: String,
WantsDementialLecture: False
}