| GET | /client/GetOrderHelper/{OrderId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderId | path | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| PersonId | form | long | No | |
| PicLink | form | string | No | |
| PicLinkOrganisation | form | string | No | |
| NotificationTime | form | DateTime? | No | |
| ReactionId | form | int | No | |
| ReactionTimeStamp | form | DateTime? | No | |
| OrderId | form | long? | No | |
| OrderSeriesId | form | long? | No | |
| NotificationsCreated | form | bool | No | |
| ForeName | form | string | No | |
| LastName | form | string | No | |
| OrganisationId | form | long? | No | |
| Company | form | string | No | |
| Address | form | ClientAddressResponse | No | |
| OverallRating | form | decimal | No | |
| CriminalRecordCertificate | form | bool | No | |
| IsSchooledHelper | form | bool | No | |
| PricePerUnit | form | decimal | No | |
| Prices | form | List<decimal> | No | |
| PreferedToPin | form | bool | No | |
| Notes | form | string | No | |
| AvailabilityDeclaredDate | form | DateTime | No | |
| TrainingCertificates | form | List<ClientPersonDocumentResponse> | No | |
| SendSepaViaClientPortal | 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 | |
| PersonId | form | long | No | |
| Name | form | string | No | |
| DocumentTypeId | form | int | No | |
| DocumentOrigin | form | int | No | |
| DateOfIssuance | form | DateTime? | 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/GetOrderHelper/{OrderId} HTTP/1.1
Host: api.helferportal.de
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
PersonId: 0,
PicLink: String,
PicLinkOrganisation: String,
NotificationTime: 0001-01-01,
ReactionId: 0,
ReactionTimeStamp: 0001-01-01,
OrderId: 0,
OrderSeriesId: 0,
NotificationsCreated: False,
ForeName: String,
LastName: String,
OrganisationId: 0,
Company: String,
Address:
{
Id: 0,
AccountId: 0,
PersonId: 0,
Street: String,
BuildingNo: String,
PostCode: String,
District: String,
City: String,
Latitude: 0,
Longitude: 0,
AddressSupplement: String
},
OverallRating: 0,
CriminalRecordCertificate: False,
IsSchooledHelper: False,
PricePerUnit: 0,
Prices:
[
0
],
PreferedToPin: False,
Notes: String,
AvailabilityDeclaredDate: 0001-01-01,
TrainingCertificates:
[
{
Id: 0,
PersonId: 0,
Name: String,
DocumentTypeId: 0,
DocumentOrigin: 0,
DateOfIssuance: 0001-01-01,
IsDeleted: False
}
],
SendSepaViaClientPortal: False
}