Name

Perform various operations on name records.

Symitar eDocs References: Coming soon.

Operations

getName

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "NameLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Name": {
    "Locator": 1,
    "Type": 0,
    "First": "JOHN",
    "Middle": "M",
    "Last": "DOE",
    "LongName": "JOHN M DOE",
    "BirthDate": "1930-05-26",
    "City": "NEW YORK",
    "State": "NY",
    "ZipCode": "10001",
    "MemberNumber": "20080920000007924",
    "MbrAddrNumber": "20080920000007924"
  },
  "MessageId": "getName"
}

getNameSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getNameSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getNameSelectFields 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
      }
    }
  },
  "AccountNumber": "0000013824",
  "NameLocator": 222,
  "SelectableFields": {
    "IncludeAllNameFields": false,
    "NameFields": {
      "Locator": true,
      "Type": true,
      "First": true,
      "Middle": true,
      "Last": true,
      "BirthDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Name": {
    "Locator": 222,
    "Type": 3,
    "First": "SETH",
    "Middle": "A",
    "Last": "ZAMORA",
    "BirthDate": null
  },
  "MessageId": "getNameSelectFields"
}

getNamePagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNamePagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "Name": [
    {
      "Locator": 1,
      "Type": 0,
      "First": "JOHN",
      "Middle": "M",
      "Last": "DOE",
      "LongName": "JOHN M DOE",
      "BirthDate": "1930-05-26"
    },
    {
      "Locator": 222,
      "Type": 3,
      "First": "SETH",
      "Middle": "A",
      "Last": "ZAMORA",
      "LongName": "SETH A ZAMORA",
      "BirthDate": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getNamePagedList"
}

getNameListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/getNameListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "SelectableFields": {
    "IncludeAllNameFields": false,
    "NameFields": {
      "Locator": true,
      "Type": true,
      "First": true,
      "Last": true,
      "LongName": true,
      "MemberNumber": true,
      "MbrAddrNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NameList": {
    "hasReachedMaximumListSize": false,
    "Name": [
      {
        "Locator": 1,
        "Type": 0,
        "First": "JOHN",
        "Last": "DOE",
        "LongName": "JOHN M DOE",
        "MemberNumber": "20080920000007924",
        "MbrAddrNumber": "20080920000007924"
      },
      {
        "Locator": 222,
        "Type": 3,
        "First": "SETH",
        "Last": "ZAMORA",
        "LongName": "SETH A ZAMORA",
        "MemberNumber": "20101280000000076",
        "MbrAddrNumber": "20101280000000077"
      }
    ]
  },
  "MessageId": "getNameListSelectFields"
}

searchNameSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/searchNameSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "SearchFilter": {
    "Query": "Last='DOE'"
  },
  "SelectableFields": {
    "IncludeAllNameFields": false,
    "NameFields": {
      "Locator": true,
      "Type": true,
      "First": true,
      "Last": true,
      "LongName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NameList": {
    "hasReachedMaximumListSize": false,
    "Name": [
      {
        "Locator": 1,
        "Type": 0,
        "First": "JOHN",
        "Last": "DOE",
        "LongName": "JOHN M DOE"
      },
      {
        "Locator": 240,
        "Type": 4,
        "First": "JACK",
        "Last": "DOE",
        "LongName": "JACK DOE"
      }
    ]
  },
  "MessageId": "searchNameSelectFields"
}

getNamePagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getNamePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 3,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllNameFields": false,
    "NameFields": {
      "Locator": true,
      "Type": true,
      "First": true,
      "Middle": true,
      "Last": true,
      "BirthDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Name": [
    {
      "Locator": 1,
      "Type": 0,
      "First": "JOHN",
      "Middle": "M",
      "Last": "DOE",
      "BirthDate": "1930-05-26"
    },
    {
      "Locator": 222,
      "Type": 3,
      "First": "SETH",
      "Middle": "A",
      "Last": "ZAMORA",
      "BirthDate": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getNamePagedListSelectFields"
}

searchNamePagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchNamePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "Query": "LOCATOR=222",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllNameFields": false,
    "NameFields": {
      "Locator": true,
      "Type": true,
      "First": true,
      "Middle": true,
      "Last": true,
      "BirthDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Name": [
    {
      "Locator": 222,
      "Type": 3,
      "First": "SETH",
      "Middle": "A",
      "Last": "ZAMORA",
      "BirthDate": null
    }
  ],
  "Token": null,
  "MessageId": "searchNamePagedSelectFields"
}

updateNameByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

NameLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/updateNameByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "NameLocator": 280,
  "NameUpdatableFields": {
    "Type": 1,
    "First": "NEXUM",
    "Last": "WAVEFOURUPD",
    "NameFormat": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

createName

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

NameLocatorintegerOptional

post/createName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "NameCreatableFields": {
    "Type": 1,
    "First": "NEXUM",
    "Last": "WAVEFOUR",
    "NameFormat": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "NameLocator": 280,
  "MessageId": "createName"
}

deleteName

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

NameLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "NameLocator": 280,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteName"
}