Home

Addresses

GET api/Patient/{systemID}/Addresses?patientID={patientID}

Retrieve listing of patient delivery addresses on file

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
patientID 
Unique ID of patient in pharmacy system.

Define this parameter in the request URI.
    

Response Codes

    
  • OK (200)
  • NotFound (404)
  • InternalServerError (500)
    •     

Response Information

List of Patient Delivery Addresses

Response body formats

application/json, text/json

Sample: 
[
  {
    "PatientID": "sample string 1",
    "Name": "sample string 2",
    "InCareOf": "sample string 3",
    "Address": "sample string 4",
    "Address2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "PhoneNumber": "sample string 9",
    "POBox": "sample string 10",
    "RefrigeratedItems": "sample string 11",
    "SpecialtyItem": "sample string 12",
    "AddressID": "sample string 13",
    "OrderNo": 1,
    "TotalAddresses": 1,
    "AddressType": "sample string 14",
    "BeginDate": "sample string 15",
    "EndDate": "sample string 16",
    "InActive": "sample string 17",
    "Notes": "sample string 18"
  },
  {
    "PatientID": "sample string 1",
    "Name": "sample string 2",
    "InCareOf": "sample string 3",
    "Address": "sample string 4",
    "Address2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "PhoneNumber": "sample string 9",
    "POBox": "sample string 10",
    "RefrigeratedItems": "sample string 11",
    "SpecialtyItem": "sample string 12",
    "AddressID": "sample string 13",
    "OrderNo": 1,
    "TotalAddresses": 1,
    "AddressType": "sample string 14",
    "BeginDate": "sample string 15",
    "EndDate": "sample string 16",
    "InActive": "sample string 17",
    "Notes": "sample string 18"
  },
  {
    "PatientID": "sample string 1",
    "Name": "sample string 2",
    "InCareOf": "sample string 3",
    "Address": "sample string 4",
    "Address2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "PhoneNumber": "sample string 9",
    "POBox": "sample string 10",
    "RefrigeratedItems": "sample string 11",
    "SpecialtyItem": "sample string 12",
    "AddressID": "sample string 13",
    "OrderNo": 1,
    "TotalAddresses": 1,
    "AddressType": "sample string 14",
    "BeginDate": "sample string 15",
    "EndDate": "sample string 16",
    "InActive": "sample string 17",
    "Notes": "sample string 18"
  }
]

text/javascript

Sample: 
[{"PatientID":"sample string 1","Name":"sample string 2","InCareOf":"sample string 3","Address":"sample string 4","Address2":"sample string 5","City":"sample string 6","State":"sample string 7","Zip":"sample string 8","PhoneNumber":"sample string 9","POBox":"sample string 10","RefrigeratedItems":"sample string 11","SpecialtyItem":"sample string 12","AddressID":"sample string 13","OrderNo":1,"TotalAddresses":1,"AddressType":"sample string 14","BeginDate":"sample string 15","EndDate":"sample string 16","InActive":"sample string 17","Notes":"sample string 18"},{"PatientID":"sample string 1","Name":"sample string 2","InCareOf":"sample string 3","Address":"sample string 4","Address2":"sample string 5","City":"sample string 6","State":"sample string 7","Zip":"sample string 8","PhoneNumber":"sample string 9","POBox":"sample string 10","RefrigeratedItems":"sample string 11","SpecialtyItem":"sample string 12","AddressID":"sample string 13","OrderNo":1,"TotalAddresses":1,"AddressType":"sample string 14","BeginDate":"sample string 15","EndDate":"sample string 16","InActive":"sample string 17","Notes":"sample string 18"},{"PatientID":"sample string 1","Name":"sample string 2","InCareOf":"sample string 3","Address":"sample string 4","Address2":"sample string 5","City":"sample string 6","State":"sample string 7","Zip":"sample string 8","PhoneNumber":"sample string 9","POBox":"sample string 10","RefrigeratedItems":"sample string 11","SpecialtyItem":"sample string 12","AddressID":"sample string 13","OrderNo":1,"TotalAddresses":1,"AddressType":"sample string 14","BeginDate":"sample string 15","EndDate":"sample string 16","InActive":"sample string 17","Notes":"sample string 18"}]

application/xml, text/xml

Sample: 
<ArrayOfPatientAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <PatientAddress>
    <Address>sample string 4</Address>
    <Address2>sample string 5</Address2>
    <AddressID>sample string 13</AddressID>
    <AddressType>sample string 14</AddressType>
    <BeginDate>sample string 15</BeginDate>
    <City>sample string 6</City>
    <EndDate>sample string 16</EndDate>
    <InActive>sample string 17</InActive>
    <InCareOf>sample string 3</InCareOf>
    <Name>sample string 2</Name>
    <Notes>sample string 18</Notes>
    <OrderNo>1</OrderNo>
    <POBox>sample string 10</POBox>
    <PatientID>sample string 1</PatientID>
    <PhoneNumber>sample string 9</PhoneNumber>
    <RefrigeratedItems>sample string 11</RefrigeratedItems>
    <SpecialtyItem>sample string 12</SpecialtyItem>
    <State>sample string 7</State>
    <TotalAddresses>1</TotalAddresses>
    <Zip>sample string 8</Zip>
  </PatientAddress>
  <PatientAddress>
    <Address>sample string 4</Address>
    <Address2>sample string 5</Address2>
    <AddressID>sample string 13</AddressID>
    <AddressType>sample string 14</AddressType>
    <BeginDate>sample string 15</BeginDate>
    <City>sample string 6</City>
    <EndDate>sample string 16</EndDate>
    <InActive>sample string 17</InActive>
    <InCareOf>sample string 3</InCareOf>
    <Name>sample string 2</Name>
    <Notes>sample string 18</Notes>
    <OrderNo>1</OrderNo>
    <POBox>sample string 10</POBox>
    <PatientID>sample string 1</PatientID>
    <PhoneNumber>sample string 9</PhoneNumber>
    <RefrigeratedItems>sample string 11</RefrigeratedItems>
    <SpecialtyItem>sample string 12</SpecialtyItem>
    <State>sample string 7</State>
    <TotalAddresses>1</TotalAddresses>
    <Zip>sample string 8</Zip>
  </PatientAddress>
  <PatientAddress>
    <Address>sample string 4</Address>
    <Address2>sample string 5</Address2>
    <AddressID>sample string 13</AddressID>
    <AddressType>sample string 14</AddressType>
    <BeginDate>sample string 15</BeginDate>
    <City>sample string 6</City>
    <EndDate>sample string 16</EndDate>
    <InActive>sample string 17</InActive>
    <InCareOf>sample string 3</InCareOf>
    <Name>sample string 2</Name>
    <Notes>sample string 18</Notes>
    <OrderNo>1</OrderNo>
    <POBox>sample string 10</POBox>
    <PatientID>sample string 1</PatientID>
    <PhoneNumber>sample string 9</PhoneNumber>
    <RefrigeratedItems>sample string 11</RefrigeratedItems>
    <SpecialtyItem>sample string 12</SpecialtyItem>
    <State>sample string 7</State>
    <TotalAddresses>1</TotalAddresses>
    <Zip>sample string 8</Zip>
  </PatientAddress>
</ArrayOfPatientAddress>