OnlineBlock

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineBlock

post

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

OnlineBlockRuleNumberintegerRequired

Responses

200

Successful operation.

application/json

post/getOnlineBlock

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineBlock": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineBlock"
}

getOnlineBlockSelectFields

post

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

OnlineBlockRuleNumberintegerOptional

Responses

200

Successful operation.

application/json

post/getOnlineBlockSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineBlockRuleNumber": 0,
  "SelectableFields": {
    "OnlineBlockFields": {
      "RuleNumber": true,
      "Description": true,
      "ExpirationDate": true
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": {
    "Description": "General Country Block",
    "ExpirationDate": null,
    "RuleNumber": 0
  },
  "MessageId": "getOnlineBlockSelectFields"
}

getOnlineBlockPagedList

post

Retrieve OnlineBlock 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/getOnlineBlockPagedList

HTTPcURLJavaScriptPython

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

{
  "OnlineBlock": [],
  "Token": null,
  "MessageId": "getOnlineBlockPagedList"
}

getOnlineBlockListSelectFields

post

Retrieve OnlineBlock 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/getOnlineBlockListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineBlockList": [],
  "MessageId": "getOnlineBlockListSelectFields"
}

searchOnlineBlockSelectFields

post

Search OnlineBlock 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/searchOnlineBlockSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineBlockList": [],
  "MessageId": "searchOnlineBlockSelectFields"
}

getOnlineBlockPagedListSelectFields

post

Retrieve OnlineBlock 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/getOnlineBlockPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineBlock": [
    {
      "Description": "General Country Block",
      "ExpirationDate": null,
      "RuleNumber": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineBlockPagedListSelectFields"
}

searchOnlineBlockPagedSelectFields

post

Search OnlineBlock 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/searchOnlineBlockPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "OnlineBlock": [
    {
      "Description": "General Country Block",
      "ExpirationDate": null,
      "RuleNumber": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineBlockPagedSelectFields"
}

updateOnlineBlockByID

post

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

OnlineBlockRuleNumberintegerOptional

Responses

200

Successful operation.

application/json

post/updateOnlineBlockByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateOnlineBlockByID 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
      }
    }
  },
  "OnlineBlockRuleNumber": "NEXW45",
  "OnlineBlockUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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