| POST | /client/PostClientOrderSeries |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderSeries | body | ClientOrderSeriesApiModel | No | |
| OrderHelper | body | List<ClientOrderHelperApiModel> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | long | No | |
| OrderDateFrom | form | DateTime? | No | |
| OrderDateTill | form | DateTime? | No | |
| FrequencyId | form | int | No | |
| StatusId | form | int | No | |
| DaysPerWeek | form | int | No | |
| PersonInNeed | form | long | No | |
| PersonGivingHelp | form | long? | No | |
| HourNeeded | form | decimal | No | |
| OrderDescription | form | string | No | |
| InterviewDate | form | DateTime? | No | |
| InterviewNotes | form | string | No | |
| IsDeleted | form | bool | No | |
| DeletionReason | form | string | No | |
| OrdersCreated | form | bool | No | |
| SkillDescription | form | string | No | |
| SelfPayer | form | bool | No | |
| FirstOrderOnly | form | bool | No | |
| Clerk | form | long | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| GenderType | form | int | No | |
| LiabilityInsurance | form | bool | No | |
| AccidentInsurance | form | bool | No | |
| BusinessTripInsurance | form | bool | No | |
| BillableViaReliefAmount | form | bool | No | |
| CriminalRecordCertificateType | form | bool | No | |
| SocialInsurance | form | bool | No | |
| HelperType | form | int | No | |
| CriminalRecordCertificate | form | bool | No | |
| CalculatingWithHelperPrices | form | bool | No | |
| VehicleType | form | int | No | |
| Liability | form | bool | No | |
| Accident | form | bool | No | |
| BusinessTravelInsurance | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| IsDispoCoordinated | form | bool | No | |
| ForServiceProvider | form | bool | No | |
| SkillCatalogTypeId | form | int | No | |
| GoingToTheToilet | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| WorkflowStatus | form | OrderWorkflowStatus | No | |
| OrderList | form | List<ClientOrderApiModel> | No | |
| AccomplishedSkills | form | List<ClientOrderSeriesSkillApiModel> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | long | No | |
| OrderDescription | form | string | No | |
| OrderDate | form | DateTime? | No | |
| StatusId | form | int | No | |
| DistanceKm | form | decimal | No | |
| HourNeeded | form | decimal | No | |
| SkillDescription | form | string | No | |
| PersonInNeed | form | long | No | |
| PersonGivenHelp | form | long? | No | |
| OrderSeriesId | form | long? | No | |
| CreatedDate | form | DateTime | No | |
| EmergencySearch | form | bool | No | |
| SelfPayer | form | bool | No | |
| Clerk | form | long | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| GenderType | form | int | No | |
| LiabilityInsurance | form | bool | No | |
| AccidentInsurance | form | bool | No | |
| BusinessTripInsurance | form | bool | No | |
| BillableViaReliefAmount | form | bool | No | |
| CriminalRecordCertificateType | form | bool | No | |
| SocialInsurance | form | bool | No | |
| HelperType | form | int | No | |
| CriminalRecordCertificate | form | bool | No | |
| CalculatingWithHelperPrices | form | bool | No | |
| VehicleType | form | int | No | |
| Liability | form | bool | No | |
| Accident | form | bool | No | |
| BusinessTravelInsurance | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| IsDispoCoordinated | form | bool | No | |
| ForServiceProvider | form | bool | No | |
| SkillCatalogTypeId | form | int | No | |
| GoingToTheToilet | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| WorkflowStatus | form | OrderWorkflowStatus | No | |
| AccomplishedSkills | form | List<ClientOrderSkillApiModel> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Name | form | string | No | |
| HoursNeeded | form | decimal | No | |
| OrderId | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderSeriesId | form | long? | No | |
| SkillId | form | long | No | |
| ScheduledTime | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PersonId | form | long | No | |
| OrderId | form | long? | No | |
| OrderSeriesId | form | long? | No | |
| NotificationsCreated | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| OrderDateFrom | form | DateTime? | No | |
| OrderDateTill | form | DateTime? | No | |
| FrequencyId | form | int | No | |
| DaysPerWeek | form | int | No | |
| PersonInNeed | form | long | No | |
| PersonGivingHelp | form | long? | No | |
| HourNeeded | form | decimal | No | |
| CreatedDate | form | DateTime? | No | |
| LastChangedDate | form | DateTime? | No | |
| Status | form | OrderStatus | No | |
| StatusId | form | int | No | |
| OrderDescription | form | string | No | |
| InterviewDate | form | DateTime? | No | |
| InterviewNotes | form | string | No | |
| IsDeleted | form | bool | No | |
| DeletionReason | form | string | No | |
| OrdersCreated | form | bool | No | |
| AcceptedHelperCount | form | int | No | |
| TotalHelperCount | form | int | No | |
| Person | form | ClientPersonResponse | No | |
| SkillDescription | form | string | No | |
| EmergencySearch | form | bool | No | |
| SelfPayer | form | bool | No | |
| Clerk | form | long | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| GenderType | form | int | No | |
| LiabilityInsurance | form | bool | No | |
| AccidentInsurance | form | bool | No | |
| BusinessTripInsurance | form | bool | No | |
| BillableViaReliefAmount | form | bool | No | |
| CriminalRecordCertificateType | form | bool | No | |
| SocialInsurance | form | bool | No | |
| HelperType | form | int | No | |
| CriminalRecordCertificate | form | bool | No | |
| CalculatingWithHelperPrices | form | bool | No | |
| VehicleType | form | int | No | |
| Liability | form | bool | No | |
| Accident | form | bool | No | |
| BusinessTravelInsurance | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| IsDispoCoordinated | form | bool | No | |
| ForServiceProvider | form | bool | No | |
| SkillCatalogTypeId | form | int | No | |
| GoingToTheToilet | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| WorkflowStatus | form | OrderWorkflowStatus | No | |
| OrderList | form | List<ClientOrderResponse> | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| Status | form | OrderStatus | No | |
| OrderDescription | form | string | No | |
| OrderSeriesId | form | long? | No | |
| PersonInNeed | form | long | No | |
| PersonGivenHelp | form | long? | No | |
| CreatedDate | form | DateTime? | No | |
| LastChangedDate | form | DateTime? | No | |
| OrderDate | form | DateTime? | No | |
| AcceptedHelperCount | form | int | No | |
| TotalHelperCount | form | int | No | |
| DistanceKm | form | decimal | No | |
| HourNeeded | form | decimal | No | |
| SkillDescription | form | string | No | |
| EmergencySearch | form | bool | No | |
| SelfPayer | form | bool | No | |
| Clerk | form | long | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| GenderType | form | int | No | |
| LiabilityInsurance | form | bool | No | |
| AccidentInsurance | form | bool | No | |
| BusinessTripInsurance | form | bool | No | |
| BillableViaReliefAmount | form | bool | No | |
| CriminalRecordCertificateType | form | bool | No | |
| SocialInsurance | form | bool | No | |
| HelperType | form | int | No | |
| CriminalRecordCertificate | form | bool | No | |
| CalculatingWithHelperPrices | form | bool | No | |
| VehicleType | form | int | No | |
| Liability | form | bool | No | |
| Accident | form | bool | No | |
| BusinessTravelInsurance | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| IsDispoCoordinated | form | bool | No | |
| ForServiceProvider | form | bool | No | |
| SkillCatalogTypeId | form | int | No | |
| Person | form | ClientPersonResponse | No | |
| IsDeleted | form | bool | No | |
| DeletionReason | form | string | No | |
| GoingToTheToilet | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| WorkflowStatus | form | OrderWorkflowStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /client/PostClientOrderSeries HTTP/1.1
Host: api.helferportal.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"OrderSeries":{"AccountId":0,"OrderDateFrom":"\/Date(-62135596800000-0000)\/","OrderDateTill":"\/Date(-62135596800000-0000)\/","FrequencyId":0,"StatusId":0,"DaysPerWeek":0,"PersonInNeed":0,"PersonGivingHelp":0,"HourNeeded":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","OrdersCreated":false,"SkillDescription":"String","SelfPayer":false,"FirstOrderOnly":false,"Clerk":0,"DrivingLicense":false,"VehicleAvailable":false,"GenderType":0,"LiabilityInsurance":false,"AccidentInsurance":false,"BusinessTripInsurance":false,"BillableViaReliefAmount":false,"CriminalRecordCertificateType":false,"SocialInsurance":false,"HelperType":0,"CriminalRecordCertificate":false,"CalculatingWithHelperPrices":false,"VehicleType":0,"Liability":false,"Accident":false,"BusinessTravelInsurance":false,"DependentChildrenCare":false,"IsDispoCoordinated":false,"ForServiceProvider":false,"SkillCatalogTypeId":0,"GoingToTheToilet":false,"FilterOnLanguages":[0],"WorkflowStatus":"Details","OrderList":[{"AccountId":0,"OrderDescription":"String","OrderDate":"\/Date(-62135596800000-0000)\/","StatusId":0,"DistanceKm":0,"HourNeeded":0,"SkillDescription":"String","PersonInNeed":0,"PersonGivenHelp":0,"OrderSeriesId":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","EmergencySearch":false,"SelfPayer":false,"Clerk":0,"DrivingLicense":false,"VehicleAvailable":false,"GenderType":0,"LiabilityInsurance":false,"AccidentInsurance":false,"BusinessTripInsurance":false,"BillableViaReliefAmount":false,"CriminalRecordCertificateType":false,"SocialInsurance":false,"HelperType":0,"CriminalRecordCertificate":false,"CalculatingWithHelperPrices":false,"VehicleType":0,"Liability":false,"Accident":false,"BusinessTravelInsurance":false,"DependentChildrenCare":false,"IsDispoCoordinated":false,"ForServiceProvider":false,"SkillCatalogTypeId":0,"GoingToTheToilet":false,"FilterOnLanguages":[0],"WorkflowStatus":"Details","AccomplishedSkills":[{"Id":0,"Name":"String","HoursNeeded":0,"OrderId":0}]}],"AccomplishedSkills":[{"OrderSeriesId":0,"SkillId":0,"ScheduledTime":0}]},"OrderHelper":[{"PersonId":0,"OrderId":0,"OrderSeriesId":0,"NotificationsCreated":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Id":0,"AccountId":0,"OrderDateFrom":"\/Date(-62135596800000-0000)\/","OrderDateTill":"\/Date(-62135596800000-0000)\/","FrequencyId":0,"DaysPerWeek":0,"PersonInNeed":0,"PersonGivingHelp":0,"HourNeeded":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","Status":"None","StatusId":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","OrdersCreated":false,"AcceptedHelperCount":0,"TotalHelperCount":0,"Person":{"Id":0,"AccountId":0,"OrganisationId":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","Notes":"String","PersonTyp":0,"CareLevel":"NoCarelevel","CareLevelDate":"\/Date(-62135596800000-0000)\/","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},"SkillDescription":"String","EmergencySearch":false,"SelfPayer":false,"Clerk":0,"DrivingLicense":false,"VehicleAvailable":false,"GenderType":0,"LiabilityInsurance":false,"AccidentInsurance":false,"BusinessTripInsurance":false,"BillableViaReliefAmount":false,"CriminalRecordCertificateType":false,"SocialInsurance":false,"HelperType":0,"CriminalRecordCertificate":false,"CalculatingWithHelperPrices":false,"VehicleType":0,"Liability":false,"Accident":false,"BusinessTravelInsurance":false,"DependentChildrenCare":false,"IsDispoCoordinated":false,"ForServiceProvider":false,"SkillCatalogTypeId":0,"GoingToTheToilet":false,"FilterOnLanguages":[0],"WorkflowStatus":"Details","OrderList":[{"Id":0,"AccountId":0,"Status":"None","OrderDescription":"String","OrderSeriesId":0,"PersonInNeed":0,"PersonGivenHelp":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","OrderDate":"\/Date(-62135596800000-0000)\/","AcceptedHelperCount":0,"TotalHelperCount":0,"DistanceKm":0,"HourNeeded":0,"SkillDescription":"String","EmergencySearch":false,"SelfPayer":false,"Clerk":0,"DrivingLicense":false,"VehicleAvailable":false,"GenderType":0,"LiabilityInsurance":false,"AccidentInsurance":false,"BusinessTripInsurance":false,"BillableViaReliefAmount":false,"CriminalRecordCertificateType":false,"SocialInsurance":false,"HelperType":0,"CriminalRecordCertificate":false,"CalculatingWithHelperPrices":false,"VehicleType":0,"Liability":false,"Accident":false,"BusinessTravelInsurance":false,"DependentChildrenCare":false,"IsDispoCoordinated":false,"ForServiceProvider":false,"SkillCatalogTypeId":0,"Person":{"Id":0,"AccountId":0,"OrganisationId":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","Notes":"String","PersonTyp":0,"CareLevel":"NoCarelevel","CareLevelDate":"\/Date(-62135596800000-0000)\/","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},"IsDeleted":false,"DeletionReason":"String","GoingToTheToilet":false,"FilterOnLanguages":[0],"WorkflowStatus":"Details"}]}