Dados de Pessoas

Este tema é uma base de dados para pessoas (incluso motoristas). Cada pessoa cadastrada tem um identificador único (Id), além de outros atributos.

Pessoas (person)

Descrição
Esta entidade padroniza os seguintes atributos:
- Nome
- data de nascimento
- foto
- gênero
- nacionalidade
- naturalidade
- nome dos pais
- idioma
- estado civil
- dados do documento principal de identificação
- dados de outros documentos
- endereço
- dados de contato
- dados profissionais
Estrutura dos campos

Aqui está a tabela atualizada com as informações fornecidas:

Campo	Descrição	Tipo	Link
dataId	identificador da pessoa	int
name	nome	string
birthDate	data de nascimento	string
photo	foto	base64
Gender
genderId	data.id (identificador) do gênero	int	genderId
genderName	nome da gênero	string	genderName
Nationality
nationality	nome da nacionalidade	string	countryNationality
Birth City
cityId	data.id (identificador) da cidade de nascimento	int	cityId
cityName	nome da cidade de nascimento	string	cityName
Parents
fatherName	nome do pai	string
motherName	nome da mãe	string
Language
languageId	data.id (identificador) do idioma principal	int	languageId
languageName	nome do idioma principal	string	languagename
Marital Status
maritalStatusId	data.id (identificador) do estado civil	int	maritalStatusId
maritalStatusName	nome do estado civil	string	maritalStatusName
Main identification document
countryId	data.id (identificador) do país do documento principal de identificação	int	countryId
countryName	nome do país do documento principal de identificação	string	countryName
documentId	data.id (identificador) do documento principal de identificação	int	documentId
documentName	nome do documento principal de identificação	string	documentName
docCategoryId	data.id (identificador) da categoria do documento principal de identificação	int	docCategoryId
docCategoryName	nome da categoria do documento principal de identificação	string	docCategoryName
documentData	número do documento principal de identificação	string
docIssuerId	data.id (identificador) do órgão emissor do documento principal de identificação	int	docIssuerId
docIssuerName	nome do órgão emissor do documento principal de identificação	string	docIssuerName
provinceIssuerId	identificador da provincia do órgão emissor do documento principal de identificação	int	provinceId
provinceIssuerName	nome da provincia do órgão emissor do documento principal de identificação	string	ProvinceName
issueDate	data de emissão do documento principal de identificação	string
expirationDate	data de vencimento do documento principal de identificação	string
firstIssueDate	data da primeira emissão do documento principal de identificação	string
docPicture	foto do documento principal de identificação	base64
complement	dados adicionais do documento principal de identificação	objeto
Document [array]
countryId	identificador do país do documento	int	countryId
countryName	nome do país do documento	string	countryName
documentId	identificador do documento	int	documentId
documentName	nome do documento	string	documentName
docCategoryId	identificador da categoria do documento	int	docCategoryId
docCategoryName	nome da categoria do documento	string	docCategoryName
documentData	número do documento	string
docIssuerId	identificador do órgão emissor do documento	int	docIssuerId
docIssuerName	nome do órgão emissor do documento	string	docIssuerName
provinceIssuerId	identificador do estado do órgão emissor do documento	int	provinceId
provinceIssuerName	nome do estado do órgão emissor do documento	string	provinceName
issueDate	data de emissão do documento	string
expirationDate	data de vencimento do documento	string
firstIssueDate	data da primeira emissão do documento	string
docPicture	foto do documento	base64
complement	dados adicionais do documento	objeto
Relationship [array]
dataId	identificador do relacionamento	int	relationshipId
dataName	nome do relacionamento	string	relationshipName
communicationTypeId	identificador do tipo de comunicação	int	communicationTypeId
communicationTypeName	nome do tipo de comunicação	string	communicationTypeName
countryPhoneCode	DDI (código de telefone) do país	int	countryPhoneCode
cityPhoneCode	DDD (código de telefone) da cidade	int	cityPhoneCode
phoneNumber	número do telefone	int
email	e-mail	string
Address [array]
countryId	identificador do país	int	countryId
countryName	nome do país	string	countryName
cityId	identificador da cidade	int	cityId
cityName	nome da cidade	string	cityName
provinceId	identificador do estado	int	provinceId
provinceName	nome do estado	string	provinceName
zipcode	CEP	string
comunity	bairro	string
addressTypeId	identificador do tipo de endereço	int	addressTypeId
addressTypeName	nome do tipo de endereço	string	addressTypeName
addressName	endereço	string
number	número	int
complement	complemento	string
propertyType	identificador do tipo de propriedade imobiliária	int	propertyTypeId
propertyName	nome do tipo de propriedade imobiliária	string	propertyTypeName
latitude	latitude	number
longitude	longitude	number
Contact [array]
communicationTypeId	identificador do tipo de comunicação	int	communicationTypeId
communicationTypeName	nome do tipo de comunicação	string	communicationTypeName
countryPhoneCode	DDI (código de telefone) do país	int	countryPhoneCode
cityPhoneCode	DDD (código de telefone) da cidade	int	cityPhoneCode
phoneNumber	número do telefone	int
email	e-mail	string
Social Media [array]
socialMediaId	identificador da media social	int	socialMediaId
socialMediaName	nome da media social	string	socialMediaName
username	username para a media social	string
URL	URL da media social	string
Professional Data [array]
contractTypeId	identificador do tipo de vínculo profissional	int	contractTypeId
contractTypeName	nome do tipo de vínculo profissional	string	contractTypeName
admissionDate	data de contratação	string
jobId	identificador da profissão	int	jobId
jobName	nome da profissão	string	jobName
companyId	identificador da empresa onde exerce a profissão	int	companyId
companyName	nome da empresa onde exerce a profissão	string	companyName
Logistic Activity [array]
logisticActivityId	array de identificadores de atividades logísticas da pessoa	int	logisticActivityId
logisticActivityName	array de nomes de atividades logísticas da pessoa	string	logisticActivityName
dataIdentifier	identificador de unicidade da entidade	string

Exemplo de chamada ao endpoint (GET) usando "queryTemplate"

Produção	`https://platform.nstech.com.br/api/mdm/entities/person/queryByTemplate/queryByDataIdentifier?paramCountryId=76&paramDocumentId=16&paramDocumentData=00000000000`
Homologação	`https://dev.nstech.com.br/platform/api/mdm-stg/entities/person/queryByTemplate/queryByDataIdentifier?paramCountryId=76&paramDocumentId=16&paramDocumentData=000000000000`

Exemplo de retorno

Clique em "JSON"

{
  "statusCode": 200,
  "success": true,
  "message": "Success",
  "document": [
    {
      "_id": "652f3236aa650f9c1b14c567",
      "status": true,
      "deleted": false,
      "updatedAt": "2023-11-13T23:28:27.023Z",
      "userCreator": "mdm-surrogate",
      "entityType": "person",
      "revision": 1,
      "data": {
        "name": "MAURO SERGIO CABRAL DE MENDONCA",
        "identificationDocument": {
          "countryId": 76,
          "countryName": "Brasil",
          "documentId": 16,
          "documentData": "000000000000",
          "documentName": "Cadastro de pessoas físicas"
        },
        "document": [
          {
            "countryId": 76,
            "countryName": "Brasil",
            "documentId": 16,
            "documentData": "000000000000",
            "documentName": "Cadastro de pessoas físicas"
          }
        ],
        "address": [
          {
            "zipcode": "750000",
            "address": ""
          },
          {
            "zipcode": "",
            "address": ""
          }
        ],
        "contact": [
          {
            "phoneNumber": 81994305656
          }
        ],
        "dataIdentifier": {
          "identificationDocument": {
            "documentData": "000000000000",
            "documentId": 16,
            "countryId": 76
          }
        }
      }
    }
  ],
  "page": 1,
  "limit": 100
}

Insira nos campos param, param2 e param3 as informações relativas as CountryId, DocumentId e DocumentData, respectivamente.