heilog.ch.Api

<back to all web services

GetPartnershipsRequest

The following routes are available for this service:
All Verbs/partnerships
GetPartnershipsRequest Parameters:
NameParameterData TypeRequiredDescription
OnlyActivePartnersqueryboolNo
GetPartnershipsResponse Parameters:
NameParameterData TypeRequiredDescription
PartnershipsformList<PartnershipDetailDto>No
PartnershipDetailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PharmacyIdformlongNo
PharmacyformPartnershipPharmacyDtoNo
TherapistIdformlongNo
TherapistformPartnershipTherapistDtoNo
MessageformstringNo
PartnershipStatusformPartnershipStatusNo
PartnershipPharmacyDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
AddressformstringNo
CityformstringNo
PostalCodeformstringNo
IsStandardPharmacistformboolNo
PartnershipTherapistDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
AddressformstringNo
CityformstringNo
PostalCodeformstringNo
PartnershipStatus Enum:
NameValue
Requested1
Accepted2
Terminated4
Withdrawn8
Declined16
Inactive28

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 /partnerships HTTP/1.1 
Host: heidak-api.build.exanic.ch 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	onlyActivePartners: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	partnerships: 
	[
		{
			id: 0,
			pharmacyId: 0,
			pharmacy: 
			{
				id: 0,
				email: String,
				phoneNumber: String,
				firstName: String,
				lastName: String,
				company: String,
				address: String,
				city: String,
				postalCode: String,
				isStandardPharmacist: False
			},
			therapistId: 0,
			therapist: 
			{
				id: 0,
				email: String,
				phoneNumber: String,
				firstName: String,
				lastName: String,
				company: String,
				address: String,
				city: String,
				postalCode: String
			},
			message: String,
			partnershipStatus: 1
		}
	]
}