Disclosure

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDisclosure

post

Retrieve Disclosure parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getDisclosure

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Disclosure": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getDisclosure"
}

getDisclosureSelectFields

post

Retrieve Disclosure parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getDisclosureSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "DisclosureFields": {
      "ClosedEndDisclosureFormat": true,
      "UseExtraAddress": true,
      "FedLine1": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "Disclosure": {
    "ClosedEndDisclosureFormat": 0,
    "FedLine1": [],
    "UseExtraAddress": true
  },
  "MessageId": "getDisclosureSelectFields"
}

updateDisclosureByID

post

Update Disclosure parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/updateDisclosureByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "DisclosureUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateDisclosureByID"
}