Warnings

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getWarnings

post

No description available.

Authorizations
Body
WarningsWarningNumberintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "Warnings": {
    "DisplayWarninginAcctMgr": true,
    "DisplayWarninginTlrTrn": true,
    "WarnDescription": "text",
    "WarnFmPriv": 1,
    "WarnIqPriv": 1,
    "WarnTrPriv": 1,
    "WarningNumber": 1
  }
}

getWarningsSelectFields

post

No description available.

Authorizations
Body
WarningsWarningNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WarningsWarningNumber": 1,
  "SelectableFields": {
    "IncludeAllWarningsFields": true,
    "WarningsFields": {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": true,
      "WarnFmPriv": true,
      "WarnIqPriv": true,
      "WarnTrPriv": true,
      "WarningNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Warnings": {
    "DisplayWarninginAcctMgr": true,
    "DisplayWarninginTlrTrn": true,
    "WarnDescription": "text",
    "WarnFmPriv": 1,
    "WarnIqPriv": 1,
    "WarnTrPriv": 1,
    "WarningNumber": 1
  }
}

getWarningsPagedList

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Warnings": [
    {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": "text",
      "WarnFmPriv": 1,
      "WarnIqPriv": 1,
      "WarnTrPriv": 1,
      "WarningNumber": 1
    }
  ],
  "Token": "text"
}

getWarningsListSelectFields

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllWarningsFields": true,
    "WarningsFields": {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": true,
      "WarnFmPriv": true,
      "WarnIqPriv": true,
      "WarnTrPriv": true,
      "WarningNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WarningsList": {
    "hasReachedMaximumListSize": true,
    "Warnings": [
      {
        "DisplayWarninginAcctMgr": true,
        "DisplayWarninginTlrTrn": true,
        "WarnDescription": "text",
        "WarnFmPriv": 1,
        "WarnIqPriv": 1,
        "WarnTrPriv": 1,
        "WarningNumber": 1
      }
    ]
  }
}

searchWarningsSelectFields

post

Fields available for selecting when retrieving Warnings data

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllWarningsFields": true,
    "WarningsFields": {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": true,
      "WarnFmPriv": true,
      "WarnIqPriv": true,
      "WarnTrPriv": true,
      "WarningNumber": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WarningsList": {
    "hasReachedMaximumListSize": true,
    "Warnings": [
      {
        "DisplayWarninginAcctMgr": true,
        "DisplayWarninginTlrTrn": true,
        "WarnDescription": "text",
        "WarnFmPriv": 1,
        "WarnIqPriv": 1,
        "WarnTrPriv": 1,
        "WarningNumber": 1
      }
    ]
  }
}

getWarningsPagedListSelectFields

post

No description available.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWarningsFields": true,
    "WarningsFields": {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": true,
      "WarnFmPriv": true,
      "WarnIqPriv": true,
      "WarnTrPriv": true,
      "WarningNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Warnings": [
    {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": "text",
      "WarnFmPriv": 1,
      "WarnIqPriv": 1,
      "WarnTrPriv": 1,
      "WarningNumber": 1
    }
  ],
  "Token": "text"
}

searchWarningsPagedSelectFields

post

Fields available for selecting when retrieving paginated Warnings data

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWarningsFields": true,
    "WarningsFields": {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": true,
      "WarnFmPriv": true,
      "WarnIqPriv": true,
      "WarnTrPriv": true,
      "WarningNumber": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Warnings": [
    {
      "DisplayWarninginAcctMgr": true,
      "DisplayWarninginTlrTrn": true,
      "WarnDescription": "text",
      "WarnFmPriv": 1,
      "WarnIqPriv": 1,
      "WarnTrPriv": 1,
      "WarningNumber": 1
    }
  ],
  "Token": "text"
}

updateWarningsByID

post

Update warnings for a specific ID.

Authorizations
Body
WarningsWarningNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WarningsWarningNumber": 1,
  "WarningsUpdatableFields": {
    "DisplayWarninginAcctMgr": true,
    "DisplayWarninginTlrTrn": true,
    "WarnDescription": "text",
    "WarnFmPriv": 1,
    "WarnIqPriv": 1,
    "WarnTrPriv": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?