PmtAppMethod

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPmtAppMethod

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PmtAppMethodTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getPmtAppMethod

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

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

200

Successful operation.

{
  "PmtAppMethod": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getPmtAppMethod"
}

getPmtAppMethodSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PmtAppMethodTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getPmtAppMethodSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PmtAppMethodType": 0,
  "SelectableFields": {
    "PmtAppMethodFields": {
      "Type": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "PmtAppMethod": {
    "Description": "Standard",
    "Type": 0
  },
  "MessageId": "getPmtAppMethodSelectFields"
}

getPmtAppMethodPagedList

post

Retrieve PmtAppMethod 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/getPmtAppMethodPagedList

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

{
  "PmtAppMethod": [],
  "Token": null,
  "MessageId": "getPmtAppMethodPagedList"
}

getPmtAppMethodListSelectFields

post

Retrieve PmtAppMethod 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/getPmtAppMethodListSelectFields

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

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

200

Successful operation.

{
  "PmtAppMethodList": [],
  "MessageId": "getPmtAppMethodListSelectFields"
}

searchPmtAppMethodSelectFields

post

Search PmtAppMethod 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/searchPmtAppMethodSelectFields

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

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

200

Successful operation.

{
  "PmtAppMethodList": [],
  "MessageId": "searchPmtAppMethodSelectFields"
}

getPmtAppMethodPagedListSelectFields

post

Retrieve PmtAppMethod 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/getPmtAppMethodPagedListSelectFields

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

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

200

Successful operation.

{
  "PmtAppMethod": [
    {
      "Description": "Standard",
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getPmtAppMethodPagedListSelectFields"
}

searchPmtAppMethodPagedSelectFields

post

Search PmtAppMethod 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/searchPmtAppMethodPagedSelectFields

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

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

200

Successful operation.

{
  "PmtAppMethod": [
    {
      "Description": "Standard",
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchPmtAppMethodPagedSelectFields"
}

updatePmtAppMethodByID

post

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

PmtAppMethodTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updatePmtAppMethodByID

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

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

200

Successful operation.

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