IPrimeSuiteAPI REST API Documentation


ScheduleLocationsGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/ScheduleLocationsGet

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<ScheduleLocationGetRequest>
  <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>
</ScheduleLocationGetRequest>

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"
    }
  },
  "PageSize": 0,
  "PageStart": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ScheduleLocationGetResponse>
  <Locations>
    <LocationID>0</LocationID>
    <Description>String Content</Description>
    <Name>String Content</Name>
    <bCanView>false</bCanView>
    <bCanSchedule>false</bCanSchedule>
    <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>
  </Locations>
  <TotalRows>0</TotalRows>
</ScheduleLocationGetResponse>

Response Format: Json

Response Example (schema):

{
  "Locations": [
    {
      "LocationID": 0,
      "Description": "String Content",
      "Name": "String Content",
      "bCanView": false,
      "bCanSchedule": false,
      "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"
      }
    }
  ],
  "TotalRows": 0
}