AcctMembGrpDesc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAcctMembGrpDesc

post

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

AcctMembGrpDescMemberGroupintegerRequired

Responses

200

Successful operation.

application/json

post/getAcctMembGrpDesc

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "AcctMembGrpDescMemberGroup": 0
}

200

Successful operation.

{
  "AcctMembGrpDesc": {
    "Description": "Member Group 0000",
    "MemberGroup": 0
  },
  "MessageId": "getAcctMembGrpDesc"
}

getAcctMembGrpDescSelectFields

post

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

AcctMembGrpDescMemberGroupintegerOptional

Responses

200

Successful operation.

application/json

post/getAcctMembGrpDescSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "AcctMembGrpDescMemberGroup": 0,
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true
  }
}

200

Successful operation.

{
  "AcctMembGrpDesc": {
    "Description": "Member Group 0000",
    "MemberGroup": 0
  },
  "MessageId": "getAcctMembGrpDescSelectFields"
}

getAcctMembGrpDescPagedList

post

Retrieve AcctMembGrpDesc 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/getAcctMembGrpDescPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  }
}

200

Successful operation.

{
  "AcctMembGrpDesc": [
    {
      "Description": "Member Group 0000",
      "MemberGroup": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getAcctMembGrpDescPagedList"
}

getAcctMembGrpDescListSelectFields

post

Retrieve AcctMembGrpDesc 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/getAcctMembGrpDescListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcctMembGrpDescList": [],
  "MessageId": "getAcctMembGrpDescListSelectFields"
}

searchAcctMembGrpDescSelectFields

post

Search AcctMembGrpDesc 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/searchAcctMembGrpDescSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcctMembGrpDescList": [],
  "MessageId": "searchAcctMembGrpDescSelectFields"
}

getAcctMembGrpDescPagedListSelectFields

post

Retrieve AcctMembGrpDesc 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/getAcctMembGrpDescPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true
  }
}

200

Successful operation.

{
  "AcctMembGrpDesc": [
    {
      "Description": "Member Group 0000",
      "MemberGroup": 0
    }
  ],
  "Token": "example-token",
  "MessageId": "getAcctMembGrpDescPagedListSelectFields"
}

searchAcctMembGrpDescPagedSelectFields

post

Search AcctMembGrpDesc 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/searchAcctMembGrpDescPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "MemberGroup=0",
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true
  }
}

200

Successful operation.

{
  "AcctMembGrpDesc": [
    {
      "Description": "Member Group 0000",
      "MemberGroup": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchAcctMembGrpDescPagedSelectFields"
}

updateAcctMembGrpDescByID

post

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

AcctMembGrpDescMemberGroupintegerOptional

Responses

200

Successful operation.

application/json

post/updateAcctMembGrpDescByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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