IPrimeSuiteAPI REST API Documentation
ScheduleAvailableSlotsGet
Method: POST
URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Scheduling/Appointment/ScheduleAvailableSlotsGet
Request Format: Xml or Json
Request XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<AvailableSlotsGetRequest>
<AdminLocations>
<Abbr>String Content</Abbr>
<ResourceID>0</ResourceID>
<ResourceCat>0</ResourceCat>
<AppointmentType>0</AppointmentType>
<AppointmentCat>0</AppointmentCat>
<AppointmentCategories>
<AppointmentCategoryID>0</AppointmentCategoryID>
<AppointmentTypes>
<Abbr>String Content</Abbr>
<AltLabel>String Content</AltLabel>
<AppointmentTypeID>0</AppointmentTypeID>
<Duration>0</Duration>
<Name>String Content</Name>
<PatientInstructions>String Content</PatientInstructions>
<ResourceCategories>
<Name>String Content</Name>
<ResourceCategoryID>0</ResourceCategoryID>
<Resources>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resources>
</ResourceCategories>
</AppointmentTypes>
<Description>String Content</Description>
<Name>String Content</Name>
</AppointmentCategories>
<LocationID>0</LocationID>
<Name>String Content</Name>
<Address>
<AddressLine1>String Content</AddressLine1>
<AddressLine2>String Content</AddressLine2>
<City>String Content</City>
<County>String Content</County>
<State>String Content</State>
<Country>String Content</Country>
<PostalCode>String Content</PostalCode>
<PhoneNumber1>String Content</PhoneNumber1>
<PhoneNumber2>String Content</PhoneNumber2>
<FaxNumber>String Content</FaxNumber>
</Address>
</AdminLocations>
<AppointmentCategory>
<AppointmentCategoryID>0</AppointmentCategoryID>
<AppointmentTypes>
<Abbr>String Content</Abbr>
<AltLabel>String Content</AltLabel>
<AppointmentTypeID>0</AppointmentTypeID>
<Duration>0</Duration>
<Name>String Content</Name>
<PatientInstructions>String Content</PatientInstructions>
<ResourceCategories>
<Name>String Content</Name>
<ResourceCategoryID>0</ResourceCategoryID>
<Resources>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resources>
</ResourceCategories>
</AppointmentTypes>
<Description>String Content</Description>
<Name>String Content</Name>
</AppointmentCategory>
<ResourceCategories>
<Name>String Content</Name>
<ResourceCategoryID>0</ResourceCategoryID>
<Resources>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resources>
</ResourceCategories>
<StartDate>0001-01-01T00:00:00</StartDate>
<EndDate>0001-01-01T00:00:00</EndDate>
<StartTime>0001-01-01T00:00:00</StartTime>
<EndTime>0001-01-01T00:00:00</EndTime>
<ChiefComplaint>String Content</ChiefComplaint>
<Comments>String Content</Comments>
<AppointmentType>
<Abbr>String Content</Abbr>
<AltLabel>String Content</AltLabel>
<AppointmentTypeID>0</AppointmentTypeID>
<Duration>0</Duration>
<Name>String Content</Name>
<PatientInstructions>String Content</PatientInstructions>
<ResourceCategories>
<Name>String Content</Name>
<ResourceCategoryID>0</ResourceCategoryID>
<Resources>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resources>
</ResourceCategories>
</AppointmentType>
<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>
<PageSize>0</PageSize>
<PageStart>0</PageStart>
</AvailableSlotsGetRequest>Request Json Example (schema):
{
"AdminLocations": [
{
"Abbr": "String Content",
"ResourceID": 0,
"ResourceCat": 0,
"AppointmentType": 0,
"AppointmentCat": 0,
"AppointmentCategories": [
{
"AppointmentCategoryID": 0,
"AppointmentTypes": [
{
"Abbr": "String Content",
"AltLabel": "String Content",
"AppointmentTypeID": 0,
"Duration": 0,
"Name": "String Content",
"PatientInstructions": "String Content",
"ResourceCategories": [
{
"Name": "String Content",
"ResourceCategoryID": 0,
"Resources": [
{
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
}
]
}
]
}
],
"Description": "String Content",
"Name": "String Content"
}
],
"LocationID": 0,
"Name": "String Content",
"Address": {
"AddressLine1": "String Content",
"AddressLine2": "String Content",
"City": "String Content",
"County": "String Content",
"State": "String Content",
"Country": "String Content",
"PostalCode": "String Content",
"PhoneNumber1": "String Content",
"PhoneNumber2": "String Content",
"FaxNumber": "String Content"
}
}
],
"AppointmentCategory": {
"AppointmentCategoryID": 0,
"AppointmentTypes": [
{
"Abbr": "String Content",
"AltLabel": "String Content",
"AppointmentTypeID": 0,
"Duration": 0,
"Name": "String Content",
"PatientInstructions": "String Content",
"ResourceCategories": [
{
"Name": "String Content",
"ResourceCategoryID": 0,
"Resources": [
{
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
}
]
}
]
}
],
"Description": "String Content",
"Name": "String Content"
},
"ResourceCategories": [
{
"Name": "String Content",
"ResourceCategoryID": 0,
"Resources": [
{
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
}
]
}
],
"StartDate": "0001-01-01T00:00:00",
"EndDate": "0001-01-01T00:00:00",
"StartTime": "0001-01-01T00:00:00",
"EndTime": "0001-01-01T00:00:00",
"ChiefComplaint": "String Content",
"Comments": "String Content",
"AppointmentType": {
"Abbr": "String Content",
"AltLabel": "String Content",
"AppointmentTypeID": 0,
"Duration": 0,
"Name": "String Content",
"PatientInstructions": "String Content",
"ResourceCategories": [
{
"Name": "String Content",
"ResourceCategoryID": 0,
"Resources": [
{
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
}
]
}
]
},
"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"
}
},
"PageSize": 0,
"PageStart": 0
}Response Format: Xml
Response XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<AvailableSlotsGetResponse>
<AvailableSlots>
<ScheduleDate>0001-01-01T00:00:00</ScheduleDate>
<StartTime>0001-01-01T00:00:00</StartTime>
<EndTime>0001-01-01T00:00:00</EndTime>
<AdminLocation>
<Abbr>String Content</Abbr>
<ResourceID>0</ResourceID>
<ResourceCat>0</ResourceCat>
<AppointmentType>0</AppointmentType>
<AppointmentCat>0</AppointmentCat>
<AppointmentCategories>
<AppointmentCategoryID>0</AppointmentCategoryID>
<AppointmentTypes>
<Abbr>String Content</Abbr>
<AltLabel>String Content</AltLabel>
<AppointmentTypeID>0</AppointmentTypeID>
<Duration>0</Duration>
<Name>String Content</Name>
<PatientInstructions>String Content</PatientInstructions>
<ResourceCategories>
<Name>String Content</Name>
<ResourceCategoryID>0</ResourceCategoryID>
<Resources>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resources>
</ResourceCategories>
</AppointmentTypes>
<Description>String Content</Description>
<Name>String Content</Name>
</AppointmentCategories>
<LocationID>0</LocationID>
<Name>String Content</Name>
<Address>
<AddressLine1>String Content</AddressLine1>
<AddressLine2>String Content</AddressLine2>
<City>String Content</City>
<County>String Content</County>
<State>String Content</State>
<Country>String Content</Country>
<PostalCode>String Content</PostalCode>
<PhoneNumber1>String Content</PhoneNumber1>
<PhoneNumber2>String Content</PhoneNumber2>
<FaxNumber>String Content</FaxNumber>
</Address>
</AdminLocation>
<Resource>
<AltLabel>String Content</AltLabel>
<Description>String Content</Description>
<Name>String Content</Name>
<OverloadLimit>0</OverloadLimit>
<OwnerCareProviderID>0</OwnerCareProviderID>
<ResourceID>0</ResourceID>
<PreferredDuration>0</PreferredDuration>
<CareProviderName>String Content</CareProviderName>
</Resource>
<Duration>0</Duration>
<OffsetStart>0</OffsetStart>
</AvailableSlots>
<TotalRows>0</TotalRows>
</AvailableSlotsGetResponse>Response Format: Json
Response Example (schema):
{
"AvailableSlots": [
{
"ScheduleDate": "0001-01-01T00:00:00",
"StartTime": "0001-01-01T00:00:00",
"EndTime": "0001-01-01T00:00:00",
"AdminLocation": {
"Abbr": "String Content",
"ResourceID": 0,
"ResourceCat": 0,
"AppointmentType": 0,
"AppointmentCat": 0,
"AppointmentCategories": [
{
"AppointmentCategoryID": 0,
"AppointmentTypes": [
{
"Abbr": "String Content",
"AltLabel": "String Content",
"AppointmentTypeID": 0,
"Duration": 0,
"Name": "String Content",
"PatientInstructions": "String Content",
"ResourceCategories": [
{
"Name": "String Content",
"ResourceCategoryID": 0,
"Resources": [
{
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
}
]
}
]
}
],
"Description": "String Content",
"Name": "String Content"
}
],
"LocationID": 0,
"Name": "String Content",
"Address": {
"AddressLine1": "String Content",
"AddressLine2": "String Content",
"City": "String Content",
"County": "String Content",
"State": "String Content",
"Country": "String Content",
"PostalCode": "String Content",
"PhoneNumber1": "String Content",
"PhoneNumber2": "String Content",
"FaxNumber": "String Content"
}
},
"Resource": {
"AltLabel": "String Content",
"Description": "String Content",
"Name": "String Content",
"OverloadLimit": 0,
"OwnerCareProviderID": 0,
"ResourceID": 0,
"PreferredDuration": 0,
"CareProviderName": "String Content"
},
"Duration": 0,
"OffsetStart": 0
}
],
"TotalRows": 0
}