GET api/v1/{facilityId}/tenants/{tenantId}/contacts

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required
tenantId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

TenantContactResponseModel

Name	Description	Type	Additional information
contacts		Collection of TenantContactResponseDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "contacts": [
    {
      "id": "ce26345d-878f-4242-b521-4c85f8d39581",
      "first_name": "sample string 2",
      "middle_initial": "sample string 3",
      "last_name": "sample string 4",
      "email": "sample string 5",
      "gate_access_code": "sample string 6",
      "description": "sample string 7",
      "primary": true,
      "alternate_contact": true,
      "phone_numbers": [
        {
          "id": "85493819-aa90-449b-854e-f04678f1c452",
          "primary": true,
          "source": "sample string 2",
          "number": "sample string 3",
          "formatted_number": "sample string 4",
          "extension": "sample string 5",
          "label": "sample string 6",
          "unformatted_number": "sample string 7"
        },
        {
          "id": "85493819-aa90-449b-854e-f04678f1c452",
          "primary": true,
          "source": "sample string 2",
          "number": "sample string 3",
          "formatted_number": "sample string 4",
          "extension": "sample string 5",
          "label": "sample string 6",
          "unformatted_number": "sample string 7"
        }
      ],
      "address": {
        "id": "5310e421-3ab2-45b8-86fa-11677b1f0ab0",
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postal": "sample string 6",
        "country": "sample string 7",
        "full_address": "sample string 2 sample string 3, sample string 4, sample string 5 sample string 6",
        "latitude": 1.0,
        "longitude": 1.0,
        "time_zone_id": "sample string 8",
        "time_zone_offset": "sample string 9",
        "invalid_data": true,
        "label": "sample string 11"
      }
    },
    {
      "id": "ce26345d-878f-4242-b521-4c85f8d39581",
      "first_name": "sample string 2",
      "middle_initial": "sample string 3",
      "last_name": "sample string 4",
      "email": "sample string 5",
      "gate_access_code": "sample string 6",
      "description": "sample string 7",
      "primary": true,
      "alternate_contact": true,
      "phone_numbers": [
        {
          "id": "85493819-aa90-449b-854e-f04678f1c452",
          "primary": true,
          "source": "sample string 2",
          "number": "sample string 3",
          "formatted_number": "sample string 4",
          "extension": "sample string 5",
          "label": "sample string 6",
          "unformatted_number": "sample string 7"
        },
        {
          "id": "85493819-aa90-449b-854e-f04678f1c452",
          "primary": true,
          "source": "sample string 2",
          "number": "sample string 3",
          "formatted_number": "sample string 4",
          "extension": "sample string 5",
          "label": "sample string 6",
          "unformatted_number": "sample string 7"
        }
      ],
      "address": {
        "id": "5310e421-3ab2-45b8-86fa-11677b1f0ab0",
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postal": "sample string 6",
        "country": "sample string 7",
        "full_address": "sample string 2 sample string 3, sample string 4, sample string 5 sample string 6",
        "latitude": 1.0,
        "longitude": 1.0,
        "time_zone_id": "sample string 8",
        "time_zone_offset": "sample string 9",
        "invalid_data": true,
        "label": "sample string 11"
      }
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "d3b5a908-02e3-47e9-8ac4-b3219b1ad804",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<TenantContactResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Tenants">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>d3b5a908-02e3-47e9-8ac4-b3219b1ad804</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <TenantContacts>
    <TenantContactResponseDataModel>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Address">
        <d4p1:Address1>sample string 2</d4p1:Address1>
        <d4p1:Address2>sample string 3</d4p1:Address2>
        <d4p1:AddressId>5310e421-3ab2-45b8-86fa-11677b1f0ab0</d4p1:AddressId>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:InvalidData>true</d4p1:InvalidData>
        <d4p1:Label>sample string 11</d4p1:Label>
        <d4p1:Latitude>1</d4p1:Latitude>
        <d4p1:Longitude>1</d4p1:Longitude>
        <d4p1:Postal>sample string 6</d4p1:Postal>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TimeZoneId>sample string 8</d4p1:TimeZoneId>
        <d4p1:TimeZoneOffset>sample string 9</d4p1:TimeZoneOffset>
      </Address>
      <AlternateContact>true</AlternateContact>
      <Description>sample string 7</Description>
      <Email>sample string 5</Email>
      <FirstName>sample string 2</FirstName>
      <GateAccessCode>sample string 6</GateAccessCode>
      <Id>ce26345d-878f-4242-b521-4c85f8d39581</Id>
      <LastName>sample string 4</LastName>
      <MiddleInitial>sample string 3</MiddleInitial>
      <PhoneNumbers xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.PhoneNumber">
        <d4p1:PhoneNumberModel>
          <d4p1:Extension>sample string 5</d4p1:Extension>
          <d4p1:FormattedNumber>sample string 4</d4p1:FormattedNumber>
          <d4p1:Label>sample string 6</d4p1:Label>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneNumberId>85493819-aa90-449b-854e-f04678f1c452</d4p1:PhoneNumberId>
          <d4p1:Primary>true</d4p1:Primary>
          <d4p1:Source>sample string 2</d4p1:Source>
          <d4p1:UnformattedNumber>sample string 7</d4p1:UnformattedNumber>
        </d4p1:PhoneNumberModel>
        <d4p1:PhoneNumberModel>
          <d4p1:Extension>sample string 5</d4p1:Extension>
          <d4p1:FormattedNumber>sample string 4</d4p1:FormattedNumber>
          <d4p1:Label>sample string 6</d4p1:Label>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneNumberId>85493819-aa90-449b-854e-f04678f1c452</d4p1:PhoneNumberId>
          <d4p1:Primary>true</d4p1:Primary>
          <d4p1:Source>sample string 2</d4p1:Source>
          <d4p1:UnformattedNumber>sample string 7</d4p1:UnformattedNumber>
        </d4p1:PhoneNumberModel>
      </PhoneNumbers>
      <Primary>true</Primary>
    </TenantContactResponseDataModel>
    <TenantContactResponseDataModel>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Address">
        <d4p1:Address1>sample string 2</d4p1:Address1>
        <d4p1:Address2>sample string 3</d4p1:Address2>
        <d4p1:AddressId>5310e421-3ab2-45b8-86fa-11677b1f0ab0</d4p1:AddressId>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:InvalidData>true</d4p1:InvalidData>
        <d4p1:Label>sample string 11</d4p1:Label>
        <d4p1:Latitude>1</d4p1:Latitude>
        <d4p1:Longitude>1</d4p1:Longitude>
        <d4p1:Postal>sample string 6</d4p1:Postal>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TimeZoneId>sample string 8</d4p1:TimeZoneId>
        <d4p1:TimeZoneOffset>sample string 9</d4p1:TimeZoneOffset>
      </Address>
      <AlternateContact>true</AlternateContact>
      <Description>sample string 7</Description>
      <Email>sample string 5</Email>
      <FirstName>sample string 2</FirstName>
      <GateAccessCode>sample string 6</GateAccessCode>
      <Id>ce26345d-878f-4242-b521-4c85f8d39581</Id>
      <LastName>sample string 4</LastName>
      <MiddleInitial>sample string 3</MiddleInitial>
      <PhoneNumbers xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.PhoneNumber">
        <d4p1:PhoneNumberModel>
          <d4p1:Extension>sample string 5</d4p1:Extension>
          <d4p1:FormattedNumber>sample string 4</d4p1:FormattedNumber>
          <d4p1:Label>sample string 6</d4p1:Label>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneNumberId>85493819-aa90-449b-854e-f04678f1c452</d4p1:PhoneNumberId>
          <d4p1:Primary>true</d4p1:Primary>
          <d4p1:Source>sample string 2</d4p1:Source>
          <d4p1:UnformattedNumber>sample string 7</d4p1:UnformattedNumber>
        </d4p1:PhoneNumberModel>
        <d4p1:PhoneNumberModel>
          <d4p1:Extension>sample string 5</d4p1:Extension>
          <d4p1:FormattedNumber>sample string 4</d4p1:FormattedNumber>
          <d4p1:Label>sample string 6</d4p1:Label>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneNumberId>85493819-aa90-449b-854e-f04678f1c452</d4p1:PhoneNumberId>
          <d4p1:Primary>true</d4p1:Primary>
          <d4p1:Source>sample string 2</d4p1:Source>
          <d4p1:UnformattedNumber>sample string 7</d4p1:UnformattedNumber>
        </d4p1:PhoneNumberModel>
      </PhoneNumbers>
      <Primary>true</Primary>
    </TenantContactResponseDataModel>
  </TenantContacts>
</TenantContactResponseModel>