CpLetter

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCpLetter

post

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

CpLetterLetterCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getCpLetter

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpLetter": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCpLetter"
}

getCpLetterSelectFields

post

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

CpLetterLetterCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getCpLetterSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "CpLetterLetterCode": 0,
  "SelectableFields": {
    "CpLetterFields": {
      "LetterCode": true,
      "Description": true,
      "Specfile": true
    }
  }
}

200

Successful operation.

{
  "CpLetter": {
    "Description": "Collection Letter 000",
    "LetterCode": null,
    "NextWorkDays": null,
    "Specfile": null
  },
  "MessageId": "getCpLetterSelectFields"
}

getCpLetterPagedList

post

Retrieve CpLetter 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/getCpLetterPagedList

HTTPcURLJavaScriptPython

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

{
  "CpLetter": [],
  "Token": null,
  "MessageId": "getCpLetterPagedList"
}

getCpLetterListSelectFields

post

Retrieve CpLetter 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/getCpLetterListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpLetterList": [],
  "MessageId": "getCpLetterListSelectFields"
}

searchCpLetterSelectFields

post

Search CpLetter 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/searchCpLetterSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpLetterList": [],
  "MessageId": "searchCpLetterSelectFields"
}

getCpLetterPagedListSelectFields

post

Retrieve CpLetter 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/getCpLetterPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpLetter": [
    {
      "Description": "Collection Letter 000",
      "LetterCode": null,
      "NextWorkDays": null,
      "Specfile": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getCpLetterPagedListSelectFields"
}

searchCpLetterPagedSelectFields

post

Search CpLetter 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/searchCpLetterPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CpLetter": [
    {
      "Description": "Collection Letter 000",
      "LetterCode": null,
      "NextWorkDays": null,
      "Specfile": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchCpLetterPagedSelectFields"
}

updateCpLetterByID

post

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

CpLetterLetterCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateCpLetterByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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