IPrimeSuiteAPI REST API Documentation
PatientDependentsGet
Method: POST
URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/PatientDependentsGet
Request Format: Xml or Json
Request XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<DependentsGetRequest>
<Header>
<SourceSiteID>String Content</SourceSiteID>
<DestinationSiteID>String Content</DestinationSiteID>
<PrimeSuiteUserID>0</PrimeSuiteUserID>
</Header>
<Credentials>
<PrimeSuiteCredential>
<PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
<PrimeSuiteUserName>String Content</PrimeSuiteUserName>
<PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
<PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
</PrimeSuiteCredential>
<VendorCredential>
<VendorLogin>String Content</VendorLogin>
<VendorPassword>String Content</VendorPassword>
</VendorCredential>
</Credentials>
<PatientId>0</PatientId>
</DependentsGetRequest>
Request Json Example (schema):
{
"Header": {
"SourceSiteID": "String Content",
"DestinationSiteID": "String Content",
"PrimeSuiteUserID": 0
},
"Credentials": {
"PrimeSuiteCredential": {
"PrimeSuiteSiteId": "String Content",
"PrimeSuiteUserName": "String Content",
"PrimeSuiteUserPassword": "String Content",
"PrimeSuiteUserAlias": "String Content"
},
"VendorCredential": {
"VendorLogin": "String Content",
"VendorPassword": "String Content"
}
},
"PatientId": 0
}
Response Format: Xml
Response XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<DependentsGetResponse>
<Dependents>
<PatientID>0</PatientID>
<OtherID>String Content</OtherID>
<PatientStatusID>0</PatientStatusID>
<PatientAge>String Content</PatientAge>
<PhotoPath>String Content</PhotoPath>
<AccountBalanceCalcMethod>2</AccountBalanceCalcMethod>
<AlternatePatientID>0</AlternatePatientID>
<AssignmentOfBenifits>0</AssignmentOfBenifits>
<CellPhoneNumber1>String Content</CellPhoneNumber1>
<CellPhoneNumber2>String Content</CellPhoneNumber2>
<Citizenship>0</Citizenship>
<Credential>0</Credential>
<CustomCredential>String Content</CustomCredential>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<DateTimeOfBirth>String Content</DateTimeOfBirth>
<Deceased>0</Deceased>
<DeceasedDate>0001-01-01T00:00:00</DeceasedDate>
<DoesPatientHaveResidentProof>false</DoesPatientHaveResidentProof>
<DriversLicenseNumber>String Content</DriversLicenseNumber>
<DriversLicenseState>0</DriversLicenseState>
<EmailAddress1>String Content</EmailAddress1>
<EmailAddress2>String Content</EmailAddress2>
<Enabled>false</Enabled>
<Ethnicity>0</Ethnicity>
<SecondaryEthnicities>0</SecondaryEthnicities>
<Firstname>String Content</Firstname>
<FullName>String Content</FullName>
<Gender>0</Gender>
<GenderIdentity>0</GenderIdentity>
<GenderIdentityDescription>String Content</GenderIdentityDescription>
<SexualOrientation>0</SexualOrientation>
<SexualOrientationDescription>String Content</SexualOrientationDescription>
<IsFinancialRisk>false</IsFinancialRisk>
<IsPatient>false</IsPatient>
<LastName>String Content</LastName>
<MaidenName>String Content</MaidenName>
<MaritalStatus>0</MaritalStatus>
<MiddleName1>String Content</MiddleName1>
<MiddleName2>String Content</MiddleName2>
<MothersMaidenName>String Content</MothersMaidenName>
<Nickname>String Content</Nickname>
<Notes>String Content</Notes>
<NoteText>String Content</NoteText>
<Occupation>String Content</Occupation>
<OriginalPatientID>0</OriginalPatientID>
<OriginalPatientIDString>String Content</OriginalPatientIDString>
<PagerNumber>String Content</PagerNumber>
<PreferredServiceLoc>String Content</PreferredServiceLoc>
<PharmacyName>String Content</PharmacyName>
<PharmacyNoteID>0</PharmacyNoteID>
<PhoneNumber1>String Content</PhoneNumber1>
<PhoneNumber2>String Content</PhoneNumber2>
<PreferredCommunicationsID>0</PreferredCommunicationsID>
<Prefix>0</Prefix>
<PrimaryLanguage>0</PrimaryLanguage>
<LanguageLookUpID>String Content</LanguageLookUpID>
<PrimaryPhoneNumber>String Content</PrimaryPhoneNumber>
<PrimaryPhysID>0</PrimaryPhysID>
<PrimaryCareProvider>String Content</PrimaryCareProvider>
<ReferringProvider>String Content</ReferringProvider>
<PreferredProviderID>0</PreferredProviderID>
<PreferredProvider>String Content</PreferredProvider>
<PrimaryWorkPhone>String Content</PrimaryWorkPhone>
<HomePhoneNumber>String Content</HomePhoneNumber>
<Race>0</Race>
<SecondaryRaces>0</SecondaryRaces>
<ReleaseOfInformation>false</ReleaseOfInformation>
<Religion>0</Religion>
<SealedFlagID>0</SealedFlagID>
<StudentStatusID>0</StudentStatusID>
<SecondaryLanguage>0</SecondaryLanguage>
<SSN>String Content</SSN>
<Suffix>0</Suffix>
<GuarantorID>0</GuarantorID>
<LocalName>String Content</LocalName>
<ResidentialAddress>
<AddressID>0</AddressID>
<Country>0</Country>
<CountryName></CountryName>
<AddressLine1>String Content</AddressLine1>
<AddressLine2>String Content</AddressLine2>
<City>String Content</City>
<PostalCode>String Content</PostalCode>
<State>0</State>
<StateString></StateString>
<County>String Content</County>
<FaxNumber>String Content</FaxNumber>
<PhoneNumber1>String Content</PhoneNumber1>
<PhoneNumber2>String Content</PhoneNumber2>
</ResidentialAddress>
<PersonID>0</PersonID>
<Picture>String Content</Picture>
<PreferredServiceLocationID>0</PreferredServiceLocationID>
<PreferredPharmacyID>0</PreferredPharmacyID>
<PBMConsent>1</PBMConsent>
</Dependents>
</DependentsGetResponse>
Response Format: Json
Response Example (schema):
Could not generate example for response. Failed with error: Specified cast is not valid.