Facility V1 and V2 API Comparison
| Endpoint | V1 Request Parameters | V2 Request Parameters | V1 Response | V2 Response | Missing in V2 | Additional in V2 | Renamed in V2 |
|---|---|---|---|---|---|---|---|
| V1 APIV2 API | facilityClassCodefacilityNamecodeCodeTypestatuscountry cityfacilityClassSubCode pageNopageSize | Facility Summary{ "facilitySummaries": [ { "uuid": "782b7f11e5204b14b35fc49acfb4ca72", "name": "dfdgfg test", "facilityId": "BLIVYWEWE3HIO", "siteId": null, "cityName": "Vijayawada", "countryName": "India", "status": "Active" }]} | Facility Summary"facilitySummaries": [ { "facilityGeoId": "0ZLOC345YFPFY", "facilityName": "Dunn Bros", "facilityType": "OperationalFacility", "facilityTypeCode": "FCT_TYPE.CUST_POOL_F", "facilityRkstCode": "GBDUL01", "facilityRktsCode": "DUL01", "cityName": "Dudley, W Midlands", "cityRkstCode": "GBDUL", "cityRktsCode": "DUL", "cityUnlocCode": "GBDDL", "cityGeoId": "1AJDC0YLYUIDB", "countryName": "United Kingdom", "countryCode": "GB", "countryGeoId": "21X0YL36747LQ", "countryRkstCode": "GB", "stateCode": null, "stateName": null, "stateGeoId": null, "brandCode": null, "longitude": -2.0781, "latitude": 52.5 }] | statussiteId | facilityTypefacilityTypeCodefacilityRkstCodefacilityRktsCodecityNamecityRkstCodecityRktsCodecityUnlocCodecityGeoIdcountryNamecountryCodecountryRkstCodestateCodestateNamestateGeoIdbrandCodelongitudelatitude | {facilityId,facilityGeoId},{name,facilityName}, | |
| V1 APIV2 API | geoIdfacilityClassCode | facilityId | Facility Detail{ "uuid": "0aa843d6ff4c46ceb851d6c57e73a3da", "facilityId": "HHNISU6FNVTML", "name": "OPS Facility check2", "facilityClassCode": "OPS", "extOwned": "true", "status": "Active", "extExposed": "false", "url": "http://www.OPS.com ", "doDAAC": null, "description": "RET1", "receiptContainerServiceType": null, "statusDetail": null, "address": { "uuid": "88c746e5dadb4f34bd50cb17ad4bb5c2", "houseNumber": "336", "street": "Spring Street", "city": "Manhattan", "postalCode": null, "poBox": null, "district": null, "territory": "New York", "countryName": "United States", "addressLine2": null, "addressLine3": null, "latitude": "40.725876", "longitude": "-74.010379", "addressQualityCheckIndicator": "true" }, "facilityDetail": [ { "uuid": "5bdd53c1a88143499009472cd117c83e", "gpsFlag": false, "gsmFlag": true, "hasOceanFreightPricing": false, "brand": null, "commFacilityType": null, "exportEnquiriesEmail": null, "importEnquiriesEmail": null, "facilityFunction": null, "facilityFunctionDesc": null, "internationalDialCode": null, "telephoneNumber": null, "facilityCapacities": [ { "uuid": "78d7da9def524ceb82dac387c9c91b22", "name": "Weight Limit Crane", "value": "66", "unitOfMeasure": "Kilogram" } ], "facilityLifeTime": null, "facilityOperation": null, "facilityCertificate": null, "facilityFinance": null, "facilityTypes": [ { "uuid": "028f2012f50f41afaf0c652003305e18", "code": "FCT_TYPE.TERMINAL", "name": "Terminal", "masterType": "FCT_TYPE", "validThroughDate": "2025-11-11", "isDeleted": "N" }, { "uuid": "de7c881d2ce644c8a597230c4cea1e6c", "code": "FCT_OPS_TYPE.ICD", "name": "Inland Container Depot", "masterType": "FCT_TYPE", "validThroughDate": "2024-12-31", "isDeleted": "N" } ], "isVesselAgent": true } ], "alternateCodes": [ { "uuid": "fb7fe839f0d545d699aefd079360ad14", "type": "ALT_CODE.RKST", "code": "USMHN66", "isDeleted": "N" }, { "uuid": "6901ea4214a2484c957219d70ac2ca9e", "type": "ALT_CODE.GEOID", "code": "HHNISU6FNVTML", "isDeleted": "N" }, { "uuid": "ee0f109f956a4ba9a6f645c8cfc905ac", "type": "ALT_CODE.IATA", "code": "U1S", "isDeleted": "Y" } ], "alternateNames": null, "operationalHours": [ { "uuid": "5ed381118471423da95e9f366ada50cb", "day": "Saturday", "openTimeHours": "09", "openTimeMinutes": "00", "closeTimeHours": "18", "closeTimeMinutes": "00", "availabilityType": "Opening Hours", "isDeleted": "N" }, { "uuid": "e7d1027d43b5457a83979588f6dc0e52", "day": "Sunday", "openTimeHours": "09", "openTimeMinutes": "00", "closeTimeHours": "15", "closeTimeMinutes": "00", "availabilityType": "Opening Hours", "isDeleted": "N" } ], "transportModes": [ { "uuid": "dh7bynbe93m2zb5haj0erquon9meqb7s", "code": "FEO", "name": "FEEDER OWN", "validThroughDate": "2024-12-31", "isDeleted": "Y" } ], "facilityServices": [ { "uuid": "ed97d943570d40b9a4fd7f3f9ab8113d", "name": "Intermodal services available: Truck", "code": "INTM", "validThroughDate": "2026-12-31", "isDeleted": "N", "isMainArchetype": false, "isActive": true }, { "uuid": "46899fca455147f68d40037511b94cab", "name": "Intermodal services available: Rail", "code": "INTM", "validThroughDate": "2025-10-20", "isDeleted": "Y", "isMainArchetype": false, "isActive": true } ], "contactDetails": [ { "uuid": "330aec8f257e48c5a0b61782d6e40ff8", "firstName": "Pravin", "lastName": "Peter", "jobTitle": null, "department": null, "validThroughDate": "2025-12-31", "otherRemarks": null, "emailDetails": [ { "uuid": "527a8b2e134b4665965e77b18cd30384", "type": "Business Email", "emailAddress": "A@dummy.com" } ], "teleCommunicationDetails": [ { "uuid": "238523fe05584b3aa52c81ea4f7e6eb4", "code": "TEL", "internationalDialingCode": "GB +44", "number": "444444444444", "extension": null, "iso2CountryCode": "GB" } ], "partyFunctionName": "HSSE" } ], "clusterId": null, "isLnsFlow": false, "isWorkflowPending": false, "isDeleted": false, "isDuplicate": false} | Facility Detail{ "facility": { "facilityId": "HHNISU6FNVTML", "name": "OPS Facility check2", "type": "OperationalFacility", "extOwned": true, "status": "Active", "extExposed": false, "url": "http://www.OPS.com ", "doDAAC": null, "address": { "houseNumber": "336", "street": "Spring Street", "city": "Manhattan", "postalCode": null, "poBox": null, "district": null, "territory": "New York", "countryName": "United States", "countryCode": "US", "addressLine2": null, "addressLine3": null, "latitude": "40.725876", "longitude": "-74.010379", "addressQualityCheckIndicator": "Do not Check" }, "parent": { "name": "Manhattan", "type": "City", "alternateCodes": [ { "codeType": "SCHEDULE D", "code": "4601" }, { "codeType": "RKST", "code": "USMHN" }, { "codeType": "LNS GEOID", "code": "2DENKHOVM8RCV" }, { "codeType": "LNS CODE", "code": "USMHN" }, { "codeType": "GEOID", "code": "2DENKHOVM8RCV" }, { "codeType": "RKTS", "code": "MHN" }, { "codeType": "UN CODE", "code": "USMHN" } ] }, "facilityDetail": { "weightLimitCraneKg": "66", "weightLimitYardKg": null, "vesselAgent": "YES", "gpsFlag": "NO", "gsmFlag": "YES", "oceanFreightPricing": "NO", "brand": null, "commFacilityType": null, "exportEnquiriesEmail": null, "importEnquiriesEmail": null, "facilityFunction": null, "facilityFunctionDesc": null, "internationalDialCode": null, "telephoneNumber": null, "facilityTypes": [ { "code": "FCT_TYPE.TERMINAL", "name": "Terminal", "masterType": "Facility type", "validThroughDate": "2025-11-11" }, { "code": "FCT_OPS_TYPE.ICD", "name": "Inland Container Depot", "masterType": "Facility type", "validThroughDate": "2024-12-31" } ] }, "alternateCodes": [ { "codeType": "RKST", "code": "USMHN66" }, { "codeType": "GEOID", "code": "HHNISU6FNVTML" } ], "openingHours": [ { "day": "Saturday", "openTimeHours": "09", "openTimeMinutes": "00", "closeTimeHours": "18", "closeTimeMinutes": "00" }, { "day": "Sunday", "openTimeHours": "09", "openTimeMinutes": "00", "closeTimeHours": "15", "closeTimeMinutes": "00" } ], "transportModes": [], "facilityServices": [ { "serviceName": "Intermodal services available: Truck", "serviceCode": "INTM", "serviceDescription": " - Intermodal services available: Truck", "validThroughDate": "2026-12-31" } ], "fences": null, "bdas": null, "contactDetails": [ { "firstName": "Pravin", "lastName": "Peter", "jobTitle": null, "department": null, "internationalDialingCdPhone": "GB +44", "extension": null, "phoneNumber": "444444444444", "internationalDialingCdMobile": null, "mobileNumber": null, "internationalDialingCodeFax": null, "faxNumber": null, "emailAddress": "A@dummy.com", "validThroughDate": "2025-12-31" } ] }} | facilityClassCodedescriptionreceiptContainerServiceTypestatusDetailfacilityCapacitynamevaluemeasuringUnitsfacilityLifeTimefacilityOperationfacilityCertificatefacilityFinancefacilityTypeisDeletedalternateCodesisDeletedalternateNamesoperationalHoursisDeletedavailabilityTypetransportModescodenamevalidThroughDateisDeletedfacilityServicesisDeletedisMainArcheTypeisActivecontactDetailsemailDetails[]telecommunicationDetails[{code,iso2CountryCode}]partyFunctionNameclusterIdisLnsFlowisWorkflowPendingisDeletedisDuplicate | typeaddresscountryCodeparentnametypealternateCodes:[{codeTypecode}]facilityDetailweightLimitCraneKgweightLimitYardKgfacilityServicesserviceDescriptionfencesbdascontactDetailsinternationalDialingCdPhonephoneNumberinternationalDialingCdMobilemobileNumberinternationalDialingCdFaxfaxNumber | {hasOceanFreightPricing,oceanFreightPricing},{isVesselAgent,vesselAgent}{operationalHours,openingHours}facilityServices{name,serviceName}{code,serviceCode} |
Was this page helpful?