CollatrlTrackingType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCollatrlTrackingType

post

Retrieve CollatrlTrackingType 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

CollatrlTrackingTypeRecordSelectionintegerOptional

CollatrlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getCollatrlTrackingType

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CollatrlTrackingType": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCollatrlTrackingType"
}

getCollatrlTrackingTypeSelectFields

post

Retrieve CollatrlTrackingType 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

CollatrlTrackingTypeRecordSelectionintegerOptional

CollatrlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getCollatrlTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "CollatrlTrackingTypeRecordSelection": 5,
  "CollatrlTrackingTypeTrackingType": 0,
  "SelectableFields": {
    "CollatrlTrackingTypeFields": {
      "RecordSelection": true,
      "TrackingType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "CollatrlTrackingType": {
    "Description": "Tracking Type 00",
    "ParentClosingOption": null,
    "RecordSelection": 5,
    "TrackingType": 0,
    "UserRate20": []
  },
  "MessageId": "getCollatrlTrackingTypeSelectFields"
}

getCollatrlTrackingTypePagedList

post

Retrieve CollatrlTrackingType 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

TokenstringOptional

post/getCollatrlTrackingTypePagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CollatrlTrackingType": [],
  "Token": null,
  "MessageId": "getCollatrlTrackingTypePagedList"
}

getCollatrlTrackingTypeListSelectFields

post

Retrieve CollatrlTrackingType 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/getCollatrlTrackingTypeListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getCollatrlTrackingTypeListSelectFields 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": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCollatrlTrackingTypeFields": true
  }
}

200

Successful operation.

{
  "CollatrlTrackingTypeList": [],
  "MessageId": "getCollatrlTrackingTypeListSelectFields"
}

searchCollatrlTrackingTypeSelectFields

post

Search CollatrlTrackingType 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/searchCollatrlTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllCollatrlTrackingTypeFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CollatrlTrackingTypeList": [],
  "MessageId": "searchCollatrlTrackingTypeSelectFields"
}

getCollatrlTrackingTypePagedListSelectFields

post

Retrieve CollatrlTrackingType 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

TokenstringOptional

post/getCollatrlTrackingTypePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "CollatrlTrackingTypeFields": {
      "RecordSelection": true,
      "TrackingType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "CollatrlTrackingType": [
    {
      "Description": "Tracking Type 00",
      "ParentClosingOption": null,
      "RecordSelection": 0,
      "TrackingType": 0,
      "UserRate20": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getCollatrlTrackingTypePagedListSelectFields"
}

searchCollatrlTrackingTypePagedSelectFields

post

Search CollatrlTrackingType 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

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchCollatrlTrackingTypePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "CollatrlTrackingTypeFields": {
      "RecordSelection": true,
      "TrackingType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "CollatrlTrackingType": [
    {
      "Description": "Tracking Type 00",
      "ParentClosingOption": null,
      "RecordSelection": 0,
      "TrackingType": 0,
      "UserRate20": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchCollatrlTrackingTypePagedSelectFields"
}

updateCollatrlTrackingTypeByID

post

Update CollatrlTrackingType 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

CollatrlTrackingTypeRecordSelectionintegerOptional

CollatrlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateCollatrlTrackingTypeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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