Crs

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCrs

post

Retrieve CRS information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getCrs

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getCrs HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Crs": {
    "BureauInfo": [
      {
        "EntryId": 1,
        "BureauInfo": "text"
      }
    ],
    "ChexSystemsVersion": [
      {
        "EntryId": 1,
        "ChexSystemsVersion": 1
      }
    ],
    "DefaultBureau": 1,
    "DpBureauInfo": [
      {
        "EntryId": 1,
        "DpBureauInfo": "text"
      }
    ],
    "DpPassword": [
      {
        "EntryId": 1,
        "DpPassword": "text"
      }
    ],
    "DpPasswordExpiration": [
      {
        "EntryId": 1,
        "DpPasswordExpiration": "2025-12-25"
      }
    ],
    "DpSubscriberCode": [
      {
        "EntryId": 1,
        "DpSubscriberCode": "text"
      }
    ],
    "HawkIndicator": "text",
    "IncludeIdvReport": true,
    "IncludeNewAccountChexReport": true,
    "IncludeOfacReport": true,
    "IncludeQualiFileReport": true,
    "InternetPassword": "text",
    "InternetPasswordExpiration": "2025-12-25",
    "InternetUserId": "text",
    "IpAddress": "text",
    "LookType": "text",
    "OperatorCode": "text",
    "OptionalFeatureCode": [
      {
        "EntryId": 1,
        "OptionalFeatureCode": "text"
      }
    ],
    "Password": [
      {
        "EntryId": 1,
        "Password": "text"
      }
    ],
    "PasswordExpiration": [
      {
        "EntryId": 1,
        "PasswordExpiration": "2025-12-25"
      }
    ],
    "ResponseFormat": [
      {
        "EntryId": 1,
        "ResponseFormat": 1
      }
    ],
    "RiskModel": [
      {
        "EntryId": 1,
        "RiskModel": "text"
      }
    ],
    "ScoreModel": [
      {
        "EntryId": 1,
        "ScoreModel": "text"
      }
    ],
    "ServiceBureauIndicator": true,
    "StrategyType": "text",
    "SubscriberCode": [
      {
        "EntryId": 1,
        "SubscriberCode": "text"
      }
    ],
    "TestEnvironment": [
      {
        "EntryId": 1,
        "TestEnvironment": true
      }
    ],
    "UseCrsParameters": true,
    "UseType": "text",
    "UserId": "text",
    "XPNSelectCheckCode": "text"
  }
}

getCrsSelectFields

post

Retrieve select fields for CRS information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getCrsSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getCrsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 895

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCrsFields": true,
    "CrsFields": {
      "BureauInfo": [
        1
      ],
      "ChexSystemsVersion": [
        1
      ],
      "DefaultBureau": true,
      "DpBureauInfo": [
        1
      ],
      "DpPassword": [
        1
      ],
      "DpPasswordExpiration": [
        1
      ],
      "DpSubscriberCode": [
        1
      ],
      "HawkIndicator": true,
      "IncludeIdvReport": true,
      "IncludeNewAccountChexReport": true,
      "IncludeOfacReport": true,
      "IncludeQualiFileReport": true,
      "InternetPassword": true,
      "InternetPasswordExpiration": true,
      "InternetUserId": true,
      "IpAddress": true,
      "LookType": true,
      "OperatorCode": true,
      "OptionalFeatureCode": [
        1
      ],
      "Password": [
        1
      ],
      "PasswordExpiration": [
        1
      ],
      "ResponseFormat": [
        1
      ],
      "RiskModel": [
        1
      ],
      "ScoreModel": [
        1
      ],
      "ServiceBureauIndicator": true,
      "StrategyType": true,
      "SubscriberCode": [
        1
      ],
      "TestEnvironment": [
        1
      ],
      "UseCrsParameters": true,
      "UseType": true,
      "UserId": true,
      "XPNSelectCheckCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Crs": {
    "BureauInfo": [
      {
        "EntryId": 1,
        "BureauInfo": "text"
      }
    ],
    "ChexSystemsVersion": [
      {
        "EntryId": 1,
        "ChexSystemsVersion": 1
      }
    ],
    "DefaultBureau": 1,
    "DpBureauInfo": [
      {
        "EntryId": 1,
        "DpBureauInfo": "text"
      }
    ],
    "DpPassword": [
      {
        "EntryId": 1,
        "DpPassword": "text"
      }
    ],
    "DpPasswordExpiration": [
      {
        "EntryId": 1,
        "DpPasswordExpiration": "2025-12-25"
      }
    ],
    "DpSubscriberCode": [
      {
        "EntryId": 1,
        "DpSubscriberCode": "text"
      }
    ],
    "HawkIndicator": "text",
    "IncludeIdvReport": true,
    "IncludeNewAccountChexReport": true,
    "IncludeOfacReport": true,
    "IncludeQualiFileReport": true,
    "InternetPassword": "text",
    "InternetPasswordExpiration": "2025-12-25",
    "InternetUserId": "text",
    "IpAddress": "text",
    "LookType": "text",
    "OperatorCode": "text",
    "OptionalFeatureCode": [
      {
        "EntryId": 1,
        "OptionalFeatureCode": "text"
      }
    ],
    "Password": [
      {
        "EntryId": 1,
        "Password": "text"
      }
    ],
    "PasswordExpiration": [
      {
        "EntryId": 1,
        "PasswordExpiration": "2025-12-25"
      }
    ],
    "ResponseFormat": [
      {
        "EntryId": 1,
        "ResponseFormat": 1
      }
    ],
    "RiskModel": [
      {
        "EntryId": 1,
        "RiskModel": "text"
      }
    ],
    "ScoreModel": [
      {
        "EntryId": 1,
        "ScoreModel": "text"
      }
    ],
    "ServiceBureauIndicator": true,
    "StrategyType": "text",
    "SubscriberCode": [
      {
        "EntryId": 1,
        "SubscriberCode": "text"
      }
    ],
    "TestEnvironment": [
      {
        "EntryId": 1,
        "TestEnvironment": true
      }
    ],
    "UseCrsParameters": true,
    "UseType": "text",
    "UserId": "text",
    "XPNSelectCheckCode": "text"
  }
}

updateCrsByID

post

Update CRS by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/updateCrsByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateCrsByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1292

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CrsUpdatableFields": {
    "BureauInfo": [
      {
        "EntryId": 1,
        "BureauInfo": "text"
      }
    ],
    "DefaultBureau": 1,
    "DpBureauInfo": [
      {
        "EntryId": 1,
        "DpBureauInfo": "text"
      }
    ],
    "DpPassword": [
      {
        "EntryId": 1,
        "DpPassword": "text"
      }
    ],
    "DpPasswordExpiration": [
      {
        "EntryId": 1,
        "DpPasswordExpiration": "2025-12-25"
      }
    ],
    "DpSubscriberCode": [
      {
        "EntryId": 1,
        "DpSubscriberCode": "text"
      }
    ],
    "HawkIndicator": "text",
    "IncludeIdvReport": true,
    "IncludeNewAccountChexReport": true,
    "IncludeOfacReport": true,
    "IncludeQualiFileReport": true,
    "InternetPassword": "text",
    "InternetPasswordExpiration": "2025-12-25",
    "InternetUserId": "text",
    "IpAddress": "text",
    "LookType": "text",
    "OperatorCode": "text",
    "OptionalFeatureCode": [
      {
        "EntryId": 1,
        "OptionalFeatureCode": "text"
      }
    ],
    "Password": [
      {
        "EntryId": 1,
        "Password": "text"
      }
    ],
    "PasswordExpiration": [
      {
        "EntryId": 1,
        "PasswordExpiration": "2025-12-25"
      }
    ],
    "ResponseFormat": [
      {
        "EntryId": 1,
        "ResponseFormat": 1
      }
    ],
    "RiskModel": [
      {
        "EntryId": 1,
        "RiskModel": "text"
      }
    ],
    "ScoreModel": [
      {
        "EntryId": 1,
        "ScoreModel": "text"
      }
    ],
    "StrategyType": "text",
    "SubscriberCode": [
      {
        "EntryId": 1,
        "SubscriberCode": "text"
      }
    ],
    "TestEnvironment": [
      {
        "EntryId": 1,
        "TestEnvironment": true
      }
    ],
    "UseCrsParameters": true,
    "UseType": "text",
    "UserId": "text",
    "XPNSelectCheckCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}