ShareDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getShareDefault

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ShareDefaultShareTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getShareDefault

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

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

200

Successful operation.

{
  "ShareDefault": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getShareDefault"
}

getShareDefaultSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ShareDefaultShareTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getShareDefaultSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "ShareDefaultShareType": 0,
  "SelectableFields": {
    "ShareDefaultFields": {
      "ShareType": true,
      "Description": true,
      "DivType": true
    }
  }
}

200

Successful operation.

{
  "ShareDefault": {
    "Description": "PRIMARY SHARE",
    "DivType": 0,
    "ShareType": 0
  },
  "MessageId": "getShareDefaultSelectFields"
}

getShareDefaultPagedList

post

Retrieve ShareDefault 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/getShareDefaultPagedList

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

{
  "ShareDefault": [],
  "Token": null,
  "MessageId": "getShareDefaultPagedList"
}

getShareDefaultListSelectFields

post

Retrieve ShareDefault 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/getShareDefaultListSelectFields

POST /nexum/627/2022.01/parameter/getShareDefaultListSelectFields 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": {
    "IncludeAllShareDefaultFields": true
  }
}

200

Successful operation.

{
  "ShareDefaultList": [],
  "MessageId": "getShareDefaultListSelectFields"
}

searchShareDefaultSelectFields

post

Search ShareDefault 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/searchShareDefaultSelectFields

POST /nexum/627/2022.01/parameter/searchShareDefaultSelectFields 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": {
    "IncludeAllShareDefaultFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ShareDefaultList": [],
  "MessageId": "searchShareDefaultSelectFields"
}

getShareDefaultPagedListSelectFields

post

Retrieve ShareDefault 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/getShareDefaultPagedListSelectFields

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

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

200

Successful operation.

{
  "ShareDefault": [
    {
      "Description": "PRIMARY SHARE",
      "DivType": 0,
      "ShareType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getShareDefaultPagedListSelectFields"
}

searchShareDefaultPagedSelectFields

post

Search ShareDefault 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/searchShareDefaultPagedSelectFields

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

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

200

Successful operation.

{
  "ShareDefault": [
    {
      "Description": "PRIMARY SHARE",
      "DivType": 0,
      "ShareType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchShareDefaultPagedSelectFields"
}

updateShareDefaultByID

post

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

ShareDefaultShareTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateShareDefaultByID

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

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

200

Successful operation.

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