p2m register data updated

Type: object
Domain: audit
Event: register_data_change
Version: 1

|
method required

Title: Method
Description: The HTTP Method of contract data change operation
Type: string
Example:
POST

uri required

Title: URI
Description: The URI of contract data change operation
Type: string
Example:
/v1/clientes/:merchantDocument/contratos/:contractCode
null

email

Title: E-mail
Description: The operator email of contract data change operation
Type: string
Example:
[email protected]
null

operator_profile

Title: Operator profile
Description: The operator profile of contract data change operation
Type: string
Example:
[email protected]
null

object required

Title: The object that represents the register data change operation
Type: object

register_code required

Title: Register code
Description: The identifier of the register
Type: string
Example:
7405aa2c-eb79-4eef-acac-52093bb2d344

merchant_document required

Title: Merchant document
Description: The merchant reference document
Type: string
Example:
99999999999999
99999999999

old_description required

Title: Old description
Description: The old register description
Type: string
Example:
Some old description

new_description required

Title: New description
Description: The new register description
Type: string
Example:
Some new description

old_status required

Title: Old register status
Description: The old register status
Type: string
Example:
Ativo
Inativo

new_status required

Title: New register status
Description: The new register status
Type: string
Example:
Ativo
Inativo

{
    "type": "object",
    "title": "p2m register data updated",
    "required": [
        "method",
        "uri",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "Method",
            "description": "The HTTP Method of contract data change operation",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "URI",
            "description": "The URI of contract data change operation",
            "examples": [
                "/v1/clientes/:merchantDocument/contratos/:contractCode",
                null
            ]
        },
        "email": {
            "type": "string",
            "title": "E-mail",
            "description": "The operator email of contract data change operation",
            "examples": [
                "[email protected]",
                null
            ]
        },
        "operator_profile": {
            "type": "string",
            "title": "Operator profile",
            "description": "The operator profile of contract data change operation",
            "examples": [
                "[email protected]",
                null
            ]
        },
        "object": {
            "type": "object",
            "title": "The object that represents the register data change operation",
            "required": [
                "register_code",
                "merchant_document",
                "old_description",
                "new_description",
                "old_status",
                "new_status"
            ],
            "properties": {
                "register_code": {
                    "type": "string",
                    "title": "Register code",
                    "description": "The identifier of the register",
                    "examples": [
                        "7405aa2c-eb79-4eef-acac-52093bb2d344"
                    ]
                },
                "merchant_document": {
                    "type": "string",
                    "title": "Merchant document",
                    "description": "The merchant reference document",
                    "examples": [
                        "99999999999999",
                        "99999999999"
                    ]
                },
                "old_description": {
                    "type": "string",
                    "title": "Old description",
                    "description": "The old register description",
                    "examples": [
                        "Some old description"
                    ]
                },
                "new_description": {
                    "type": "string",
                    "title": "New description",
                    "description": "The new register description",
                    "examples": [
                        "Some new description"
                    ]
                },
                "old_status": {
                    "type": "string",
                    "title": "Old register status",
                    "description": "The old register status",
                    "examples": [
                        "Ativo",
                        "Inativo"
                    ]
                },
                "new_status": {
                    "type": "string",
                    "title": "New register status",
                    "description": "The new register status",
                    "examples": [
                        "Ativo",
                        "Inativo"
                    ]
                }
            }
        }
    }
}
{
    "method": "POST",
    "uri": "/v1/clientes/:merchantDocument/contratos/:contractCode",
    "email": "[email protected]",
    "operator_profile": "[email protected]",
    "object": {
        "register_code": "7405aa2c-eb79-4eef-acac-52093bb2d344",
        "merchant_document": "99999999999999",
        "old_description": "Some old description",
        "new_description": "Some new description",
        "old_status": "Ativo",
        "new_status": "Ativo"
    }
}