AcctTrackingType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAcctTrackingType

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AcctTrackingTypeRecordSelectionintegerOptional

AcctTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getAcctTrackingType

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "AcctTrackingTypeRecordSelection": 39,
  "AcctTrackingTypeTrackingType": 1
}

200

Successful operation.

{
  "AcctTrackingType": {
    "Description": "FICS Status Inquiry",
    "Field": [
      {
        "EntryId": 1,
        "Field": "Name Locator Code"
      }
    ],
    "ParentClosingOption": false,
    "RecordSelection": 39,
    "TrackingType": 1
  },
  "MessageId": "getAcctTrackingType"
}

getAcctTrackingTypeSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AcctTrackingTypeRecordSelectionintegerOptional

AcctTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getAcctTrackingTypeSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "AcctTrackingTypeRecordSelection": 39,
  "AcctTrackingTypeTrackingType": 0,
  "SelectableFields": {
    "IncludeAllAcctTrackingTypeFields": true
  }
}

200

Successful operation.

{
  "AcctTrackingType": {
    "Description": "MC Status Inquiry",
    "Field": [
      {
        "EntryId": 1,
        "Field": "User Number 01"
      }
    ],
    "ParentClosingOption": false,
    "RecordSelection": 39,
    "TrackingType": 0
  },
  "MessageId": "getAcctTrackingTypeSelectFields"
}

getAcctTrackingTypePagedList

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getAcctTrackingTypePagedList

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "AcctTrackingType": [],
  "Token": null,
  "MessageId": "getAcctTrackingTypePagedList"
}

getAcctTrackingTypeListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getAcctTrackingTypeListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllAcctTrackingTypeFields": true
  }
}

200

Successful operation.

{
  "AcctTrackingTypeList": [],
  "MessageId": "getAcctTrackingTypeListSelectFields"
}

searchAcctTrackingTypeSelectFields

post

Search AcctTrackingType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchAcctTrackingTypeSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllAcctTrackingTypeFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "AcctTrackingTypeList": [],
  "MessageId": "searchAcctTrackingTypeSelectFields"
}

getAcctTrackingTypePagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getAcctTrackingTypePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllAcctTrackingTypeFields": true
  }
}

200

Successful operation.

{
  "AcctTrackingType": [
    {
      "Description": "MC Status Inquiry",
      "Field": [
        {
          "EntryId": 1,
          "Field": "User Number 01"
        }
      ],
      "ParentClosingOption": false,
      "RecordSelection": 39,
      "TrackingType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getAcctTrackingTypePagedListSelectFields"
}

searchAcctTrackingTypePagedSelectFields

post

Search AcctTrackingType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchAcctTrackingTypePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllAcctTrackingTypeFields": true
  }
}

200

Successful operation.

{
  "AcctTrackingType": [
    {
      "Description": "MC Status Inquiry",
      "Field": [
        {
          "EntryId": 1,
          "Field": "User Number 01"
        }
      ],
      "ParentClosingOption": false,
      "RecordSelection": 39,
      "TrackingType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchAcctTrackingTypePagedSelectFields"
}

updateAcctTrackingTypeByID

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AcctTrackingTypeRecordSelectionintegerOptional

AcctTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateAcctTrackingTypeByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AcctTrackingTypeRecordSelection": 1,
  "AcctTrackingTypeTrackingType": 1,
  "AcctTrackingTypeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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