GET api/v1/{facilityId}/info
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
FacilityInfoResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| facility | FacilityInfoResponseDataModel |
None. |
|
| meta | ApiResponseMeta |
None. |
Response Formats
application/json, text/json
Sample:
{
"facility": {
"id": "f8a5283e-78a3-4afc-9549-cc4b5cf61b2e",
"name": "sample string 2",
"company_id": "74113ccf-42da-463c-be6c-c1e67af766b5",
"brand_name": "sample string 3",
"gate_provider_name": "sample string 4",
"phone": "sample string 5",
"direct_phone": "sample string 6",
"fax": "sample string 7",
"email": "sample string 8",
"invoice_period": "sample string 9",
"invoice_day": 1,
"website_url": "sample string 10",
"logo_url": "sample string 11",
"store_number": "sample string 12",
"notice": "sample string 13",
"lead_reservation_window": 1,
"offer_free_truck": true,
"minimum_unit_price": 14.0,
"address": {
"id": "f2dd6326-a6af-4ad2-9e86-a3c397008ac8",
"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"
},
"office_hours": {
"id": "3d756886-e91b-46b7-873b-62a70ddc151f",
"note": "sample string 1",
"hours_type": "sample string 2",
"hours": [
{
"id": "7c2126f0-5c4e-4475-b414-e5a121ea36d1",
"day": "sample string 1",
"open": 1.1,
"close": 1.1,
"day_id": 1,
"OpenTime": "00:00:00.1234567",
"CloseTime": "00:00:00.1234567"
},
{
"id": "7c2126f0-5c4e-4475-b414-e5a121ea36d1",
"day": "sample string 1",
"open": 1.1,
"close": 1.1,
"day_id": 1,
"OpenTime": "00:00:00.1234567",
"CloseTime": "00:00:00.1234567"
}
]
},
"access_hours": {
"id": "3d756886-e91b-46b7-873b-62a70ddc151f",
"note": "sample string 1",
"hours_type": "sample string 2",
"hours": [
{
"id": "7c2126f0-5c4e-4475-b414-e5a121ea36d1",
"day": "sample string 1",
"open": 1.1,
"close": 1.1,
"day_id": 1,
"OpenTime": "00:00:00.1234567",
"CloseTime": "00:00:00.1234567"
},
{
"id": "7c2126f0-5c4e-4475-b414-e5a121ea36d1",
"day": "sample string 1",
"open": 1.1,
"close": 1.1,
"day_id": 1,
"OpenTime": "00:00:00.1234567",
"CloseTime": "00:00:00.1234567"
}
]
},
"facility_amenities": [
{
"id": "ab4515d7-d0fa-40dc-97de-683d21d23257",
"name": "sample string 2",
"description": "sample string 3"
},
{
"id": "ab4515d7-d0fa-40dc-97de-683d21d23257",
"name": "sample string 2",
"description": "sample string 3"
}
]
},
"meta": {
"message": "sample string 1",
"status_code": 2,
"request_id": "d4afe4c7-afbb-440d-9e3d-276e6dd0b2a3",
"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:
<FacilityInfoResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Facility">
<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>d4afe4c7-afbb-440d-9e3d-276e6dd0b2a3</RequestId>
<RequestMethod>sample string 4</RequestMethod>
</Meta>
<Facility>
<AccessHours>
<Hours>
<FacilityHoursModel>
<Close>1.1</Close>
<CloseTemp>PT0.1234567S</CloseTemp>
<CloseTime>PT0.1234567S</CloseTime>
<Day>sample string 1</Day>
<DayId>1</DayId>
<HoursId>7c2126f0-5c4e-4475-b414-e5a121ea36d1</HoursId>
<Open>1.1</Open>
<OpenTemp>PT0.1234567S</OpenTemp>
<OpenTime>PT0.1234567S</OpenTime>
</FacilityHoursModel>
<FacilityHoursModel>
<Close>1.1</Close>
<CloseTemp>PT0.1234567S</CloseTemp>
<CloseTime>PT0.1234567S</CloseTime>
<Day>sample string 1</Day>
<DayId>1</DayId>
<HoursId>7c2126f0-5c4e-4475-b414-e5a121ea36d1</HoursId>
<Open>1.1</Open>
<OpenTemp>PT0.1234567S</OpenTemp>
<OpenTime>PT0.1234567S</OpenTime>
</FacilityHoursModel>
</Hours>
<HoursContainerId>3d756886-e91b-46b7-873b-62a70ddc151f</HoursContainerId>
<HoursType>sample string 2</HoursType>
<Note>sample string 1</Note>
</AccessHours>
<Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Address">
<d3p1:Address1>sample string 2</d3p1:Address1>
<d3p1:Address2>sample string 3</d3p1:Address2>
<d3p1:AddressId>f2dd6326-a6af-4ad2-9e86-a3c397008ac8</d3p1:AddressId>
<d3p1:City>sample string 4</d3p1:City>
<d3p1:Country>sample string 7</d3p1:Country>
<d3p1:InvalidData>true</d3p1:InvalidData>
<d3p1:Label>sample string 11</d3p1:Label>
<d3p1:Latitude>1</d3p1:Latitude>
<d3p1:Longitude>1</d3p1:Longitude>
<d3p1:Postal>sample string 6</d3p1:Postal>
<d3p1:State>sample string 5</d3p1:State>
<d3p1:TimeZoneId>sample string 8</d3p1:TimeZoneId>
<d3p1:TimeZoneOffset>sample string 9</d3p1:TimeZoneOffset>
</Address>
<Brandname>sample string 3</Brandname>
<CompanyId>74113ccf-42da-463c-be6c-c1e67af766b5</CompanyId>
<DirectPhone>sample string 6</DirectPhone>
<Email>sample string 8</Email>
<FacilityAmenities>
<FacilityAmenitiesModel>
<AddressId>ab4515d7-d0fa-40dc-97de-683d21d23257</AddressId>
<Description>sample string 3</Description>
<Name>sample string 2</Name>
</FacilityAmenitiesModel>
<FacilityAmenitiesModel>
<AddressId>ab4515d7-d0fa-40dc-97de-683d21d23257</AddressId>
<Description>sample string 3</Description>
<Name>sample string 2</Name>
</FacilityAmenitiesModel>
</FacilityAmenities>
<FacilityId>f8a5283e-78a3-4afc-9549-cc4b5cf61b2e</FacilityId>
<Fax>sample string 7</Fax>
<GateProviderName>sample string 4</GateProviderName>
<InvoiceDay>1</InvoiceDay>
<InvoicePeriod>sample string 9</InvoicePeriod>
<LeadReservationWindow>1</LeadReservationWindow>
<LogoUrl>sample string 11</LogoUrl>
<MinimumUnitPrice>14</MinimumUnitPrice>
<Name>sample string 2</Name>
<Notice>sample string 13</Notice>
<OfferFreeTruck>true</OfferFreeTruck>
<OfficeHours>
<Hours>
<FacilityHoursModel>
<Close>1.1</Close>
<CloseTemp>PT0.1234567S</CloseTemp>
<CloseTime>PT0.1234567S</CloseTime>
<Day>sample string 1</Day>
<DayId>1</DayId>
<HoursId>7c2126f0-5c4e-4475-b414-e5a121ea36d1</HoursId>
<Open>1.1</Open>
<OpenTemp>PT0.1234567S</OpenTemp>
<OpenTime>PT0.1234567S</OpenTime>
</FacilityHoursModel>
<FacilityHoursModel>
<Close>1.1</Close>
<CloseTemp>PT0.1234567S</CloseTemp>
<CloseTime>PT0.1234567S</CloseTime>
<Day>sample string 1</Day>
<DayId>1</DayId>
<HoursId>7c2126f0-5c4e-4475-b414-e5a121ea36d1</HoursId>
<Open>1.1</Open>
<OpenTemp>PT0.1234567S</OpenTemp>
<OpenTime>PT0.1234567S</OpenTime>
</FacilityHoursModel>
</Hours>
<HoursContainerId>3d756886-e91b-46b7-873b-62a70ddc151f</HoursContainerId>
<HoursType>sample string 2</HoursType>
<Note>sample string 1</Note>
</OfficeHours>
<Phone>sample string 5</Phone>
<StoreNumber>sample string 12</StoreNumber>
<WebsiteUrl>sample string 10</WebsiteUrl>
</Facility>
</FacilityInfoResponseModel>