Returning Physical Object data

The GET method for the Physical Object object returns information about a defined physical object in the fact store by ID.

The GET method produces application/xml and application/json.

URI

GET baseurl/fact/physical_object/{object_id}

Request content

The request for this method contains no JSON content.

Response content

The XML format for this service is detailed in the CFM/Data/XSD/PhysicalObject.xsd file.

The JSON uses the following format:

{
   "id":physical_object_id,
   "name":"physical_object_name",
   "description":"description_text",
   "objectType":{
      "value":"object_type",
      "typeTable":"CFFACT.PHYSICAL_OBJECT_TYPE"},
   "objectMake":{
      "value":"object_make",
      "typeTable":"CFFACT.PHYSICAL_OBJECT_MAKE"},
   "objectModel":{
      "value":"object_model",
      "typeTable":"CFFACT.PHYSICAL_OBJECT_MODEL"},
   "objectColor":{
      "value":"object_color",
      "typeTable":"CFFACT.PHYSICAL_OBJECT_COLOR"},
   "manufactureDate":"manufacture_date",
   "identifier":"physical_object_identifier",
   "geography":{
      "value":"geography_type",
      "typeTable":"CFFACT.GEOGRAPHY"},
   "pastConfirmedFraud":true_false,
   "pastSuspectedFraud":true_false,
   "digitalFingerprints":{
      "digitalFingerprint":{[{
         "id":fingerprint_id,
         "screenWidth":screen_width,
         "screenHeight":screen_height,
         "screenDPI":screen_dpi,
         "screenTouch":touch_screen,
         "clientLanguage":"client_language",
         "acceptEncoding":"accept_encoding_type",
         "acceptLanguage":"accept_language",
         "acceptCharset":"accept_charset",
         "activeXEnabled":true_false,
         "platform":"platform_value",
         "os":"operating_system",
         "cpu":"cpu_value",
         "primaryMAC":"primary_mac_address",
         "jsEnabled":true_false
      }]},
      "networkAccesses":{
         "networkAccess":[{
            "id":network_access_id,
            "ipClass":"ip_class",
            "ipAddress":"ip_address",
            "ipTimeZoneOffset":ip_time_zone_offset,
            "clientTimeZoneOffset":client_time_zone_offset,
            "counter":counter_value,
            "firstAccess":"time_stamp",
            "lastAccess":"time_stamp",
            "lastChange":"time_stamp",
            "ispName":"ip_name",
            "organization":"organization_name",
            "browser":"browser_name",
            "browserVersion":"browser_version",
            "userAgent":"user_agent",
            "application":"application_name",
            "business":"business_value",
            "xforwardedFor":"xforwarded_for"
      }]},
   "registrations":{
      "registrations":[{
         "registrationNumber":"registration_number",
         "issuanceTimestamp":"time_stamp",
         "expiryTimestamp":"time_stamp",
         "registrationType":{
            "value":"registration_type",
            "typeTable":"CFFACT.PHYSICAL_OBJECT_REGISTRATION_TYPE"}
      }]
   },
   "physicalObjectRelationships":{
      "objectReferences":[{
         "objectReference":{
            "objectID":"object_id",
            "objectType":"physical_object"},
            "referenceType":{
               "value":"reference_type",
               "typeTable":"CFFACT.PHYSICAL_OBJECT_RELATIONSHIP_TYPE"},
         "source":true_false},
         ...
      }]
   },
   "physicalObjectAgreements":{
      "physicalObjectAgreements":[{
         "physicalObjectAgreementId":null,
         "startTimestamp":"time_stamp",
         "endTimestamp":"time_stamp",
         "establishedTimestamp":"time_stamp",
         "value":"agreement_value",
         "agreementType":{
            "value":"agreement_type",
            "typeTable":"CFFACT.PHYSICAL_OBJECT_AGREEMENT_TYPE"},
         "physicalObjectAgreementRoles":{
            "physicalObjectAgreementRoleParty":[{
               "id":"party_id"},
               {"id":"party_id"}]
            }
         }]
      },
      "properties":{
         "property":[{
            "type":{
               "value":"property_type",
               "typeTable":"CFFACT.PHYSICAL_OBJECT_PROPERTY_TYPE"},
            "value":"property_value",
            "form":{"typeTable":"CFFACT.PROPERTY_FORM"}
         }]
      },
      "valueAssessments":{
         "valueAssessment":[{
            "id":value_assessment_id,
            "valueAssessmentType":{
               "value":"value_assessment_type",
               "typeTable":"CFFACT.VALUE_ASSESSMENT_TYPE"},
            "assessedValue":"assessed_value",
            "assessmentTimeStamp":"time_stamp"
         }]
      },
      "locations":{
         "location":[{
            "locationId":location_id,
            "locationType":{
               "value":"location_type",
               "typeTable":"SPATIAL.SPATIAL_LOCATION_TYPE"},
            "name":"location_name",
            "description":"description_text",
            "location":"POINT (point_1 point_2)",
            "parentLocationId":parent_location_id,
            "startTimeStamp":"time_stamp",
            "endTimeStamp":"time_stamp",
            "streetAddress":{
               "id":address_id,
               "number":"address_number",
               "careOf":"care_of_value",
               "line1":"address_line_1",
               "city":"city_name",
               "code":"postal_code",
               "county":"county_name",
               "state":"state_name",
               "country":"country_name",
               "properties":{
                  "property"[{
                     "type":{
                        "value":"property_type_value",
                        "typeTable":"SPATIAL.SPATIAL_LOCATION_PROPERTY_TYPE"},
                     "value":"property_value",
                     "form":{"typeTable":"CFFACT.PROPERTY_FORM"}
            }]
         }
      }]
   },
   "paymentInstrument":{
      "id":payment_instrument_id,
      "objectId":object_id,
      "transaction":{
         "objectID":"object_id",
         "objectType":"object_type"},
      "accountNumber":"account_number",
      "routingCode":"routing_code",
      "instrumentNumber":"instrument_number",
      "account":{
         "objectID":"object_id",
         "objectType":"account"},
      "image":"image_value",
      "organizationName":"organization_name",
      "value":"payment_value",
      "currency":"payment_currency",
      "date":"payment_date",
      "payline":"payline_text",
      "memoline":"memoline_text",
      "originCode":"origin_code",
      "paymentInstrumentType":{
         "value":"payment_instrument_type",
         "typeTable":"CFFACT.PAYMENT_INSTRUMENT_TYPE"},
      "rejections":{
         "rejections":[{
            "rejectionId":"rejection_id",
            "details":"rejection_details_text",
            "Type":{
               "value":"rejection_type",
               "typeTable":"CFFACT.PAYMENT_INSTRUMENT_REJECTION_TYPE"}
         }]
      },
      "paymentInstrumentsRelationships":{
         "paymentInstrumentsRelationships":[{
            "paymentInstrumentId":"payment_instrument_id",
            "objectId":object_id,
            "relationshipType":{
               "value":"relationship_type",
               "typeTable":"CFFACT.PAYMENT_INSTRUMENT_RELATIONSHIP_TYPE"},
            "source":true_false
         }]
      },
      "crossed":true_false
   }
}

The time_stamp value is returned as a string in ISO 8601 format, such as 2015-06-19T09:19:33.692-05:00.

The entity that is returned by this service is Object. If no data is found for the specified ID, a 404 Not Found message is returned.

Table 1. Response codes for the GET method
Code Description
200 OK The method completed successfully, and the physical object data is returned.
405 Method Not Allowed A required parameter was missing.
404 Not Found The physical object that was specified in the request was not found or an invalid (non-numeric) object_id value was specified.