Esta tema contém os padrões MDM para estados civis
Estados civis (maritalStatus)
-
Descrição
Esta entidade padroniza os seguintes atributos de estados civis:- Id
- nome
-
Estrutura dos Campos
Campo Descrição Tipo Link id identificador do estado civil int name nome do estado civil string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4882fdf838348471edd", "entityType": "maritalStatus", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "Marital Status Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity. An integer value.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of Marital Status.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "maritalStatus": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T15:18:35.243Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636faeae062b1fff9d9d024e", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Casado", "dataId": 1, "dataIdentifier": { "name": "Casado" } }, "createdAt": "2022-11-12T14:33:18.325Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:18.325Z" }, { "_id": "636faeb0062b1fff9d9d0250", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Casada", "dataId": 2, "dataIdentifier": { "name": "Casada" } }, "createdAt": "2022-11-12T14:33:20.096Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:20.096Z" }, { "_id": "636faeb1dd04eb0288a17d6c", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Divorciado", "dataId": 3, "dataIdentifier": { "name": "Divorciado" } }, "createdAt": "2022-11-12T14:33:21.324Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:21.324Z" }, { "_id": "636faeb2062b1fff9d9d0252", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Divorciada", "dataId": 4, "dataIdentifier": { "name": "Divorciada" } }, "createdAt": "2022-11-12T14:33:22.534Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:22.534Z" }, { "_id": "636faeb3dd04eb0288a17d6e", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Separado", "dataId": 5, "dataIdentifier": { "name": "Separado" } }, "createdAt": "2022-11-12T14:33:23.682Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:23.682Z" }, { "_id": "636faeb4062b1fff9d9d0254", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Separada", "dataId": 6, "dataIdentifier": { "name": "Separada" } }, "createdAt": "2022-11-12T14:33:24.727Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:24.727Z" }, { "_id": "636faeb5dd04eb0288a17d70", "entityType": "maritalStatus", "revision": 1, "data": { "name": "solteiro", "dataId": 7, "dataIdentifier": { "name": "solteiro" } }, "createdAt": "2022-11-12T14:33:25.830Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:25.830Z" }, { "_id": "636faeb6dd04eb0288a17d72", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Solteira", "dataId": 8, "dataIdentifier": { "name": "Solteira" } }, "createdAt": "2022-11-12T14:33:26.972Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:26.972Z" }, { "_id": "636faeb8dd04eb0288a17d74", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Viuvo", "dataId": 9, "dataIdentifier": { "name": "Viuvo" } }, "createdAt": "2022-11-12T14:33:28.830Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:28.830Z" }, { "_id": "636faeb9dd04eb0288a17d76", "entityType": "maritalStatus", "revision": 1, "data": { "name": "Viuva", "dataId": 10, "dataIdentifier": { "name": "Viuva" } }, "createdAt": "2022-11-12T14:33:29.928Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T14:33:29.928Z" } ], "page": 1, "limit": 10, "nextPageURL": "Last Page" }