TrackingCode

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getTrackingCode

post

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

TrackingCodeCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getTrackingCode

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TrackingCode": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getTrackingCode"
}

getTrackingCodeSelectFields

post

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

TrackingCodeCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getTrackingCodeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "TrackingCodeCode": 0,
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true
  }
}

200

Successful operation.

{
  "TrackingCode": {
    "Code": 0,
    "Description": null
  },
  "MessageId": "getTrackingCodeSelectFields"
}

getTrackingCodePagedList

post

Retrieve TrackingCode 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/getTrackingCodePagedList

HTTPcURLJavaScriptPython

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

{
  "TrackingCode": [],
  "Token": null,
  "MessageId": "getTrackingCodePagedList"
}

getTrackingCodeListSelectFields

post

Retrieve TrackingCode 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/getTrackingCodeListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllTrackingCodeFields": true
  }
}

200

Successful operation.

{
  "TrackingCodeList": [],
  "MessageId": "getTrackingCodeListSelectFields"
}

searchTrackingCodeSelectFields

post

Search TrackingCode 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/searchTrackingCodeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TrackingCodeList": [],
  "MessageId": "searchTrackingCodeSelectFields"
}

getTrackingCodePagedListSelectFields

post

Retrieve TrackingCode 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/getTrackingCodePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TrackingCode": [
    {
      "Code": 0,
      "Description": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getTrackingCodePagedListSelectFields"
}

searchTrackingCodePagedSelectFields

post

Search TrackingCode 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/searchTrackingCodePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TrackingCode": [
    {
      "Code": 0,
      "Description": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchTrackingCodePagedSelectFields"
}

updateTrackingCodeByID

post

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

TrackingCodeCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateTrackingCodeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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