NonAccountNameService

Manage non-account name records.

Symitar eDocs References: Coming soon.

Operations

getNonAcctName

post

Retrieves a non-account name.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringRequired

Responses

200

Successful operation.

application/json

post/getNonAcctName

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "NonAcctName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getNonAcctName"
}

getNonAcctNameSelectFields

post

Retrieves a non-account name with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/getNonAcctNameSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "SelectableFields": {
    "IncludeAllNonAcctNameFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getNonAcctNameSelectFields"
}

getNonAcctNameSelectFieldsFilterChildren

post

Retrieves a non-account name with selected fields and filtered children.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/getNonAcctNameSelectFieldsFilterChildren

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "SelectableFields": {
    "IncludeAllNonAcctNameFields": true
  },
  "ChildrenSearchFilter": {
    "NonAcctNameFmHistoryFilter": {
      "Query": "example-query"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getNonAcctNameSelectFieldsFilterChildren"
}

getNonAcctNameFmHistoryPagedList

post

Retrieves a paged list of non-account names from history.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNonAcctNameFmHistoryPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctNameFmHistory": [],
  "Token": null,
  "MessageId": "getNonAcctNameFmHistoryPagedList"
}

getNonAcctNameFmHistoryListSelectFields

post

Retrieves a list of non-account names with selected fields from history.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/getNonAcctNameFmHistoryListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctNameFmHistoryList": [],
  "MessageId": "getNonAcctNameFmHistoryListSelectFields"
}

searchNonAcctNameFmHistorySelectFields

post

Searches non-account names from history with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/searchNonAcctNameFmHistorySelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "NonAcctNameFmHistoryList": [],
  "MessageId": "searchNonAcctNameFmHistorySelectFields"
}

getNonAcctNameFmHistoryPagedListSelectFields

post

Retrieves a paged list of non-account names with selected fields from history.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNonAcctNameFmHistoryPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctNameFmHistory": [],
  "Token": null,
  "MessageId": "getNonAcctNameFmHistoryPagedListSelectFields"
}

searchNonAcctNameFmHistoryPagedSelectFields

post

Searches non-account names from history with pagination and selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchNonAcctNameFmHistoryPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "Query": "example-query",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NonAcctNameFmHistory": [],
  "Token": null,
  "MessageId": "searchNonAcctNameFmHistoryPagedSelectFields"
}

updateNonAcctNameByID

post

Updates a non-account name by its ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/updateNonAcctNameByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "example-value",
  "NonAcctNameUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

createNonAcctName

post

Creates a non-account name.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

NonAcctNameNonAcctNameNumstringOptional

post/createNonAcctName

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "NonAcctNameNonAcctNameNum": "example-value",
  "MessageId": "createNonAcctName"
}

deleteNonAcctName

post

Deletes a non-account name.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NonAcctNameNonAcctNameNumstringRequired

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteNonAcctName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "NonAcctNameNonAcctNameNum": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {},
  "MessageId": "deleteNonAcctName"
}