AcctRelCodeDesc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAcctRelCodeDesc

post

Retrieve AcctRelCodeDesc 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/getAcctRelCodeDesc

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcctRelCodeDesc": {
    "RelationshipCode": [
      {
        "EntryId": 0,
        "RelationshipCode": "Relationship Code 00"
      },
      {
        "EntryId": 1,
        "RelationshipCode": "Bronze"
      },
      {
        "EntryId": 2,
        "RelationshipCode": "Silver"
      },
      {
        "EntryId": 3,
        "RelationshipCode": "Gold"
      }
    ]
  },
  "MessageId": "getAcctRelCodeDesc"
}

getAcctRelCodeDescSelectFields

post

Retrieve AcctRelCodeDesc 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/getAcctRelCodeDescSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "AcctRelCodeDescFields": {
      "RelationshipCode": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "AcctRelCodeDesc": {
    "RelationshipCode": [
      {
        "EntryId": 1,
        "RelationshipCode": "Bronze"
      }
    ]
  },
  "MessageId": "getAcctRelCodeDescSelectFields"
}

updateAcctRelCodeDescByID

post

Update AcctRelCodeDesc 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/updateAcctRelCodeDescByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateAcctRelCodeDescByID 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}"
    }
  },
  "AcctRelCodeDescUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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