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 .xml suffix or ?format=xml

HTTP + XML

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.test.exanic.ch 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPartnershipsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Partnership">
  <OnlyActivePartners>false</OnlyActivePartners>
</GetPartnershipsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPartnershipsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Partnership">
  <Partnerships xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Partnership">
    <d2p1:PartnershipDetailDto>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:PartnershipStatus>Requested</d2p1:PartnershipStatus>
      <d2p1:Pharmacy>
        <d2p1:Address>String</d2p1:Address>
        <d2p1:City>String</d2p1:City>
        <d2p1:Company>String</d2p1:Company>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsStandardPharmacist>false</d2p1:IsStandardPharmacist>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PostalCode>String</d2p1:PostalCode>
      </d2p1:Pharmacy>
      <d2p1:PharmacyId>0</d2p1:PharmacyId>
      <d2p1:Therapist>
        <d2p1:Address>String</d2p1:Address>
        <d2p1:City>String</d2p1:City>
        <d2p1:Company>String</d2p1:Company>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PostalCode>String</d2p1:PostalCode>
      </d2p1:Therapist>
      <d2p1:TherapistId>0</d2p1:TherapistId>
    </d2p1:PartnershipDetailDto>
  </Partnerships>
</GetPartnershipsResponse>