IdentIdTypeDesc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getIdentIdTypeDesc

post

Retrieve IdentIdTypeDesc 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/getIdentIdTypeDesc

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getIdentIdTypeDesc 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.

{
  "IdentIdTypeDesc": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getIdentIdTypeDesc"
}

getIdentIdTypeDescSelectFields

post

Retrieve IdentIdTypeDesc 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/getIdentIdTypeDescSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "IdentIdTypeDesc": {
    "IdType": [
      {
        "EntryId": 1,
        "IdType": "Known Existing Member"
      }
    ]
  },
  "MessageId": "getIdentIdTypeDescSelectFields"
}

updateIdentIdTypeDescByID

post

Update IdentIdTypeDesc 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/updateIdentIdTypeDescByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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