NonAccountNameService

Manage non-account name records.

Symitar eDocs References: Coming soon.

Operations

getNonAcctNameSelectFields

post

Retrieves a non-account name with selected fields.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/getNonAcctNameSelectFields

POST /nexum/627/persistent/nonaccountname/getNonAcctNameSelectFields 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&"
    }
  },
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/getNonAcctNameSelectFieldsFilterChildren

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "SelectableFields": {
    "IncludeAllNonAcctNameFields": true
  },
  "ChildrenSearchFilter": {
    "NonAcctNameFmHistoryFilter": {
      "StartPostDate": "2010-05-08",
      "EndPostDate": "2010-05-08",
      "Query": "example-query"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

getNonAcctNameFmHistoryPagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNonAcctNameFmHistoryPagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchNonAcctNameFmHistoryPagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "12345",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "SelectableFields": {
    "IncludeAllNonAcctNameFmHistoryFields": true
  },
  "SearchFilter": {
    "StartPostDate": "2010-05-08",
    "EndPostDate": "2010-05-08",
    "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringOptional

Responses

200

Successful operation.

application/json

post/updateNonAcctNameByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "example-value",
  "NonAcctNameFields": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

createNonAcctName

post

Creates a non-account name.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

NonAcctNameNonAcctNameNumstringOptional

post/createNonAcctName

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameFields": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

deleteNonAcctName

post

Deletes a non-account name.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

NonAcctNameNonAcctNameNumstringRequired

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteNonAcctName

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NonAcctNameNonAcctNameNum": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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