Get Factory Risk Profile

GET 
/api/v1/analytics/factory-risk-profile/:factory_id

Get Factory Risk Profile

Request

Path Parameters

factory_id stringrequired

Query Parameters

date_type string

Possible values: [process_computed_date]

The type of the filtered date. Case-sensitive.

date_from daterequired

Start date of the query range in yyyy-mm-dd format

date_to daterequired

End date of the query range in yyyy-mm-dd format

client_id string

Unique identifier of the Brand or Retailer that the factory produces for

Responses

200

OK

application/json

Schema

Schema

data

object

Factory risk profile data

factoryInformation

object

nullable

The detailed information about the Factory

localOrganizationId stringnullable

The Local Custom Id of the Factory

localOrganizationIds string[]nullable

The list of all connected Local Custom Ids of the Factory

organizationId integernullable

The Global organization Id of the Factory

inspectionData

object

nullable

Inspection data of the factory risk profile

inspectionHistories

object[]

nullable

The previous inspections

Array [

caseNumber stringnullable

Case number of the inspection which the risk score is calculated based on

date datenullable

Date of the inspection which the risk score is calculated based on

result stringnullable

Result of the inspection which the risk score is calculated based on

]

inspectionLasted

object

nullable

The last inspection

caseNumber stringnullable

Case number of the inspection which the risk score is calculated based on

date datenullable

Date of the inspection which the risk score is calculated based on

result stringnullable

Result of the inspection which the risk score is calculated based on

riskLevelData

object

nullable

Risk level data of the factory risk profile

highMax integernullable

The highest score of the High Risk range

highMin integernullable

The lowest score of the High Risk range

lowMax integernullable

The highest score of the Low Risk range

lowMin integernullable

The lowest score of the Low Risk range

mediumMax integernullable

The highest score of the Medium Risk range

mediumMin integernullable

The lowest score of the Medium Risk range

scoreData

object

nullable

Score data of the factory risk profile

currentScore

object

nullable

Current risk score of the factory

labelData

object[]

nullable

Risk label of the factory

Array [

label stringnullable

Type of label

labelValue stringnullable

Value of label

reasonCode stringnullable

The selected Top Reason Code when changing Factory Risk Configuration Mode to Manual

reasonType stringnullable

The selected Top Reason Type when changing Factory Risk Configuration Mode to Manual

]

processComputedDate datenullable

The last activity date of the score for either FRP score update or risk label/configuration change

score numbernullable

Factory risk score

lastScore

object

nullable

Last risk score of the factory

labelData

object[]

nullable

Risk label of the factory

Array [

label stringnullable

Type of label

labelValue stringnullable

Value of label

reasonCode stringnullable

The selected Top Reason Code when changing Factory Risk Configuration Mode to Manual

reasonType stringnullable

The selected Top Reason Type when changing Factory Risk Configuration Mode to Manual

]

processComputedDate datenullable

The last activity date of the score for either FRP score update or risk label/configuration change

score numbernullable

Factory risk score

Example (from schema)

{
  "data": {
    "factoryInformation": {
      "localOrganizationId": "client_1",
      "localOrganizationIds": [
        "F323333",
        "F242146"
      ],
      "organizationId": 291524
    },
    "inspectionData": {
      "inspectionHistories": [
        {
          "caseNumber": "178292020-04-16MAgarmentCo.,LtdDUPRO",
          "date": "2021-04-29",
          "result": "fail"
        }
      ],
      "inspectionLasted": {
        "caseNumber": "178292020-04-16MAgarmentCo.,LtdDUPRO",
        "date": "2021-04-29",
        "result": "fail"
      }
    },
    "riskLevelData": {
      "highMax": 100,
      "highMin": 95,
      "lowMax": 11,
      "lowMin": 0,
      "mediumMax": 94,
      "mediumMin": 12
    },
    "scoreData": {
      "currentScore": {
        "labelData": [
          {
            "label": "Manual",
            "labelValue": "Low",
            "reasonCode": "Others - mandatory to fill in comments",
            "reasonType": "Others"
          }
        ],
        "processComputedDate": "2022-06-28",
        "score": 10.5
      },
      "lastScore": {
        "labelData": [
          {
            "label": "Manual",
            "labelValue": "Low",
            "reasonCode": "Others - mandatory to fill in comments",
            "reasonType": "Others"
          }
        ],
        "processComputedDate": "2022-06-28",
        "score": 10.5
      }
    }
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...