Service

<back to all web services

PostClientOrderAssessment

The following routes are available for this service:
POST/client/OrderAssessment/Create
PostClientOrderAssessment Parameters:
NameParameterData TypeRequiredDescription
OrderAssessmentbodyCreateClientOrderAssessmentApiModelNo
CreateClientOrderAssessmentApiModel Parameters:
NameParameterData TypeRequiredDescription
OrderIdformlong?No
OrderSeriesIdformlong?No
PersonInNeedIdformlongNo
CreatedAtformDateTimeNo
PersonGivingHelpIdformlongNo
AvoidHelperformboolNo
PreferHelperformboolNo
DescriptionTextformstringNo
OriginformintNo
AnonymformboolNo
ClientOrderAssessmentResponseModel Parameters:
NameParameterData TypeRequiredDescription
OrderAssessmentIdformlongNo
OrderIdformlong?No
OrderSeriesIdformlong?No
PersonInNeedIdformlongNo
CreatedAtformDateTimeNo
PersonGivingHelpIdformlongNo
AvoidHelperformboolNo
PreferHelperformboolNo
TextformstringNo
OriginformOrderAssessmentOriginNo
AnonymformboolNo

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.

POST /client/OrderAssessment/Create HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OrderAssessment: 
	{
		OrderId: 0,
		OrderSeriesId: 0,
		PersonInNeedId: 0,
		CreatedAt: 0001-01-01,
		PersonGivingHelpId: 0,
		AvoidHelper: False,
		PreferHelper: False,
		DescriptionText: String,
		Origin: 0,
		Anonym: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	OrderAssessmentId: 0,
	OrderId: 0,
	OrderSeriesId: 0,
	PersonInNeedId: 0,
	CreatedAt: 0001-01-01,
	PersonGivingHelpId: 0,
	AvoidHelper: False,
	PreferHelper: False,
	Text: String,
	Origin: Admin,
	Anonym: False
}