Service

<back to all web services

PutOrderReadyForInvoice

The following routes are available for this service:
PUT/Order/ReadyForInvoice
PutOrderReadyForInvoice Parameters:
NameParameterData TypeRequiredDescription
DistanceKmbodydecimalNo
HoursNeededbodydecimalNo
OrderIdbodylongNo
AccomplishedSkillsbodyList<OrderSkillResponse>No
OrderSkillResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
HoursNeededformdecimalNo
OrderIdformlong?No
OrderResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StatusformOrderStatusNo
StatusIdformintNo
PersonInNeedformlongNo
PersonGivenHelpformlong?No
OrderSeriesIdformlong?No
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
OrderDateformDateTime?No
HourNeededformdecimalNo
OrderDescriptionformstringNo
InterviewDateformDateTime?No
InterviewNotesformstringNo
IsDeletedformboolNo
DeletionReasonformstringNo
PersonformPersonResponseNo
SkillDescriptionformstringNo
DistanceKmformdecimal?No
PersonResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SalutationformintNo
TitleformintNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTime?No
CriminalRecordCertificateValidTillformDateTime?No
CertificatedformDateTime?No
NotesformstringNo
PersonTypformintNo
IsHelperformboolNo
CareLevelformCareLevelNo
PhoneNumberformstringNo
EMailformstringNo
MobileformstringNo
GenderformintNo
SearchForTrainedHelperformboolNo
GendertypeformGenderNo
GeographicalFrameformintNo
DeletedformboolNo
PicLinkformstringNo
BlobPicLinkformstringNo
AddressformAddressResponseNo
UserformUserResponseNo
FullMonthlyCapacityformboolNo
FilterOnLanguagesformList<int>No
CompanyformstringNo
HomeVisitsformboolNo
OperationAreaformstringNo
IkNumberformstringNo
OpeningHoursformstringNo
PersonHelperTypformPersonHelperTypeNo
EverydayHelperIsFullTimeformintNo
EverydayHelperIsFullTimeTypeformPersonEverydayHelperTypeNo
DrivingLicenseformboolNo
VehicleAvailableformboolNo
VehicleTypeformVehicleTypeNo
VehicleTypeIdformintNo
GoingToTheToiletformboolNo
CriminalRecordCertificateformboolNo
ChargeableformboolNo
BillableThroughHealthInsuranceformboolNo
BillableViaIntegrationAssistanceformboolNo
NoInterviewRequiredformboolNo
InitialInterviewformboolNo
CalculationOnPointsformboolNo
SmartphoneformboolNo
GetNewsletterformboolNo
DependentChildrenCareformboolNo
MeaslesProtectionformboolNo
InterestsformstringNo
JobformstringNo
WantsDementialLectureformboolNo
HoursPerMonthformintNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
PaymentTypeIdformlongNo
PaymentTypeformPaymentTypesNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
AddressSupplementformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
UserResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EMailformstringNo
PasswordformstringNo
IsAdministratorformboolNo
IsSuperAdminformboolNo
PersonIdformlongNo
UserVerifiedformboolNo
UserUnlockedformboolNo
IsDeletedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Order/ReadyForInvoice HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DistanceKm: 0,
	HoursNeeded: 0,
	OrderId: 0,
	AccomplishedSkills: 
	[
		{
			Id: 0,
			Name: String,
			HoursNeeded: 0,
			OrderId: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Status: None,
	StatusId: 0,
	PersonInNeed: 0,
	PersonGivenHelp: 0,
	OrderSeriesId: 0,
	CreatedDate: 0001-01-01,
	LastChangedDate: 0001-01-01,
	OrderDate: 0001-01-01,
	HourNeeded: 0,
	OrderDescription: String,
	InterviewDate: 0001-01-01,
	InterviewNotes: String,
	IsDeleted: False,
	DeletionReason: String,
	Person: 
	{
		Id: 0,
		Forename: String,
		Lastname: String,
		Birthday: 0001-01-01,
		Notes: String,
		PersonTyp: 0,
		CareLevel: NoCarelevel,
		PhoneNumber: String,
		EMail: String,
		Mobile: String,
		Gender: 0,
		SearchForTrainedHelper: False,
		Gendertype: male,
		GeographicalFrame: 0,
		Deleted: False,
		PicLink: String,
		BlobPicLink: String,
		Address: 
		{
			Id: 0,
			PersonId: 0,
			Street: String,
			BuildingNo: String,
			AddressSupplement: String,
			PostCode: String,
			District: String,
			City: String,
			Latitude: 0,
			Longitude: 0
		},
		User: 
		{
			Id: 0,
			EMail: String,
			Password: String,
			IsAdministrator: False,
			IsSuperAdmin: False,
			PersonId: 0,
			UserVerified: False,
			UserUnlocked: False,
			IsDeleted: False
		},
		FullMonthlyCapacity: False,
		FilterOnLanguages: 
		[
			0
		],
		PersonHelperTyp: EverydayHelper
	},
	SkillDescription: String
}