GET Clients/Address

Request Information

URI Parameters

Name	Type	Additional information
EntityID	integer	None.
AddressTypeEntryID	integer	None.
BusinessUnits	Collection of integer	None.
BUCreatedDateUtcMin	date	None.
BUCreatedDateUtcMax	date	None.
BULastUpdatedDateUtcMin	date	None.
BULastUpdatedDateUtcMax	date	None.
EffectiveDateUtc	date	None.
StartDateUtcMin	date	None.
StartDateUtcMax	date	None.
StopDateUtcMin	date	None.
StopDateUtcMax	date	None.
Description	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
County	string	None.
ProvinceStateCode	string	None.
PostalZipCode	string	None.
CountryCode	string	None.
Directions	string	None.
GeoDataExists	boolean	None.
AddressID	integer	None.
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
Match	MatchCriteriaStringType	None.

Body Parameters

None.

Response Information

Resource Description

Collection of AddressDTO

Name	Type	Additional information
AddressID	integer	None.
EntityID	integer	None.
AddressTypeEntryID	integer	None.
StartDateUtc	date	None.
StopDateUtc	date	None.
Description	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
County	string	None.
ProvinceStateCode	string	None.
PostalZipCode	string	None.
CountryCode	string	None.
Directions	string	None.
GeoDataExists	boolean	None.
GeoLatitude	decimal number	None.
GeoLongitude	decimal number	None.
GeoProps	Collection of Object	None.
SortOrder	integer	None.
PartialData	PartialDataType	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
AddressTypeEntryValue	string	None.
IsPrimary	boolean	None.
Summary	string	None.
SummaryShort	string	None.
SummaryMasked	string	None.
SummaryLink	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "addressID": 1,
    "entityID": 2,
    "addressTypeEntryID": 3,
    "startDateUtc": "2024-12-04T07:56:14.8574145+00:00",
    "stopDateUtc": "2024-12-04T07:56:14.8574145+00:00",
    "description": "sample string 5",
    "addressLine1": "sample string 6",
    "addressLine2": "sample string 7",
    "city": "sample string 8",
    "county": "sample string 9",
    "provinceStateCode": "sample string 10",
    "postalZipCode": "sample string 11",
    "countryCode": "sample string 12",
    "directions": "sample string 13",
    "geoDataExists": true,
    "geoLatitude": 1.0,
    "geoLongitude": 1.0,
    "sortOrder": 15,
    "partialData": 1,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:56:14.8574145+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:56:14 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:56:14.8574145+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:56:14 AM"
    },
    "addressTypeEntryValue": "sample string 16",
    "isPrimary": true,
    "summary": "sample string 6, sample string 7, sample string 8, sample string 10, sample string 11",
    "summaryShort": "sample string 6, sample string 7, sample string 8",
    "summaryMasked": "sample string, sample string, sample string 8",
    "summaryLink": "http://maps.google.com/maps?&q=sample+string+6%2c+sample+string+7%2c+sample+string+10%2c+sample+string+11%2c+sample+string+12"
  },
  {
    "addressID": 1,
    "entityID": 2,
    "addressTypeEntryID": 3,
    "startDateUtc": "2024-12-04T07:56:14.8574145+00:00",
    "stopDateUtc": "2024-12-04T07:56:14.8574145+00:00",
    "description": "sample string 5",
    "addressLine1": "sample string 6",
    "addressLine2": "sample string 7",
    "city": "sample string 8",
    "county": "sample string 9",
    "provinceStateCode": "sample string 10",
    "postalZipCode": "sample string 11",
    "countryCode": "sample string 12",
    "directions": "sample string 13",
    "geoDataExists": true,
    "geoLatitude": 1.0,
    "geoLongitude": 1.0,
    "sortOrder": 15,
    "partialData": 1,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:56:14.8574145+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:56:14 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:56:14.8574145+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:56:14 AM"
    },
    "addressTypeEntryValue": "sample string 16",
    "isPrimary": true,
    "summary": "sample string 6, sample string 7, sample string 8, sample string 10, sample string 11",
    "summaryShort": "sample string 6, sample string 7, sample string 8",
    "summaryMasked": "sample string, sample string, sample string 8",
    "summaryLink": "http://maps.google.com/maps?&q=sample+string+6%2c+sample+string+7%2c+sample+string+10%2c+sample+string+11%2c+sample+string+12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AddressDTO>
    <AddressID>1</AddressID>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <AddressTypeEntryID>3</AddressTypeEntryID>
    <AddressTypeEntryValue>sample string 16</AddressTypeEntryValue>
    <City>sample string 8</City>
    <CountryCode>sample string 12</CountryCode>
    <County>sample string 9</County>
    <Created>
      <DateUtc>2024-12-04T07:56:14.8574145+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <Description>sample string 5</Description>
    <Directions>sample string 13</Directions>
    <EntityID>2</EntityID>
    <GeoDataExists>true</GeoDataExists>
    <GeoLatitude>1</GeoLatitude>
    <GeoLongitude>1</GeoLongitude>
    <GeoProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <IsPrimary>true</IsPrimary>
    <LastUpdated>
      <DateUtc>2024-12-04T07:56:14.8574145+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <PartialData>FullData</PartialData>
    <PostalZipCode>sample string 11</PostalZipCode>
    <ProvinceStateCode>sample string 10</ProvinceStateCode>
    <RecordState>Active</RecordState>
    <SortOrder>15</SortOrder>
    <StartDateUtc>2024-12-04T07:56:14.8574145+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T07:56:14.8574145+00:00</StopDateUtc>
  </AddressDTO>
  <AddressDTO>
    <AddressID>1</AddressID>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <AddressTypeEntryID>3</AddressTypeEntryID>
    <AddressTypeEntryValue>sample string 16</AddressTypeEntryValue>
    <City>sample string 8</City>
    <CountryCode>sample string 12</CountryCode>
    <County>sample string 9</County>
    <Created>
      <DateUtc>2024-12-04T07:56:14.8574145+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <Description>sample string 5</Description>
    <Directions>sample string 13</Directions>
    <EntityID>2</EntityID>
    <GeoDataExists>true</GeoDataExists>
    <GeoLatitude>1</GeoLatitude>
    <GeoLongitude>1</GeoLongitude>
    <GeoProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <IsPrimary>true</IsPrimary>
    <LastUpdated>
      <DateUtc>2024-12-04T07:56:14.8574145+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <PartialData>FullData</PartialData>
    <PostalZipCode>sample string 11</PostalZipCode>
    <ProvinceStateCode>sample string 10</ProvinceStateCode>
    <RecordState>Active</RecordState>
    <SortOrder>15</SortOrder>
    <StartDateUtc>2024-12-04T07:56:14.8574145+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T07:56:14.8574145+00:00</StopDateUtc>
  </AddressDTO>
</ArrayOfAddressDTO>

application/x-compressed-json

Sample:

��T�N�0~���lصM���T!T8T���@Ճ[�"�]۩�B<�W�8)�������7�7�����}�F�s+����
�"���`���u�2�@y��;)r�Y�ϼ8�%*�4�&tggxQ��d�e��H�O0.0FA���\��J�V�p�1�H��RUI���v(� a�N�a����Эq}����T�8���g�E�"�x�aF��4��Į�	4@ZQ��]��%4L������Vt�!�
�!*��Ѫz
9m����C��M���{�V[�u�٥��Qq���V�:a��&�/��ڦa6�2M��̲YH����������s��K9����ۑm��(݉�}�~S�%������ 8B�cK���yq��U��z���=��W�����YÌ�VZW�������??��I/�̷h9Y�1D�FF0
��ܺͭ�ܺͭ�nݏ?+����