Versions Compared

Version Old Version 6 New Version 7
Changes made by

Alfredo Bernal

Alfredo Bernal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PRE

Método

POST

URL

https://sif-pre.uno-internacional.com/mcs/sif/empresas/{empresaRefId}/sessions/{sessionRefId}/unoSchool/{unoSchoolRefId}/crm/sync

Query Params

empresaRefId: Id de la empresa en BDC

sessionRefId: Id del ciclo escolar en BDC

unoSchoolRefId: Id del colegio en BDC

Json Schema

Code Block
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "articles": {
      "type": "object",
      "properties": {
        "failOnErrors": {
          "type": "boolean"
        },
        "operations": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "action": {
                  "type": "string"
                },
                "data": {
                  "type": "object",
                  "properties": {
                    "articleDescription": {
                      "type": "string"
                    },
                    "articleCode": {
                      "type": "string"
                    },
                    "articleOrder": {
                      "type": "integer"
                    },
                    "abbreviation": {
                      "type": "string"
                    },
                    "alternateName": {
                      "type": "string"
                    },
                    "parameter": {
                      "type": "string"
                    },
                    "sapId": {
                      "type": "string"
                    },
                    "ean": {
                      "type": "string"
                    },
                    "isbn": {
                      "type": "string"
                    },
                    "alternateEan": {
                      "type": "string"
                    },
                    "weight": {
                      "type": "integer"
                    },
                    "width": {
                      "type": "integer"
                    },
                    "height": {
                      "type": "integer"
                    },
                    "length": {
                      "type": "integer"
                    },
                    "exclusive": {
                      "type": "boolean"
                    },
                    "cdBook": {
                      "type": "string"
                    },
                    "pages": {
                      "type": "integer"
                    },
                    "collection": {
                      "type": "string"
                    },
                    "yearPublication": {
                      "type": "string"
                    },
                    "editorial": {
                      "type": "string"
                    },
                    "active": {
                      "type": "boolean"
                    },
                    "articleAuthor": {
                      "type": "object",
                      "properties": {
                        "firstName": {
                          "type": "string"
                        },
                        "middleName": {
                          "type": "string"
                        },
                        "lastName": {
                          "type": "string"
                        },
                        "timeZone": {
                          "type": "object",
                          "properties": {
                            "refId": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "refId"
                          ]
                        },
                        "language": {
                          "type": "object",
                          "properties": {
                            "refId": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "refId"
                          ]
                        }
                      },
                      "required": [
                        "firstName",
                        "middleName",
                        "lastName",
                        "timeZone",
                        "language"
                      ]
                    },
                    "subject": {
                      "type": "object",
                      "properties": {
                        "subjectCode": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "subjectCode"
                      ]
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "parameter": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "parameter"
                      ]
                    },
                    "empresa": {
                      "type": "object",
                      "properties": {
                        "refId": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "refId"
                      ]
                    },
                    "articleType": {
                      "type": "object",
                      "properties": {
                        "parameter": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "parameter"
                      ]
                    },
                    "stamp": {
                      "type": "object",
                      "properties": {
                        "stampCode": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "stampCode"
                      ]
                    },
                    "groupArticle": {
                      "type": "object",
                      "properties": {
                        "parameter": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "parameter"
                      ]
                    },
                    "materialType": {
                      "type": "object",
                      "properties": {
                        "parameter": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "parameter"
                      ]
                    },
                    "articleGradePeriods": {
                      "type": "array",
                      "items": [
                        {
                          "type": "object",
                          "properties": {
                            "articleGradePeriod": {
                              "type": "object",
                              "properties": {
                                "refId": {
                                  "type": "string"
                                },
                                "active": {
                                  "type": "boolean"
                                },
                                "grade": {
                                  "type": "object",
                                  "properties": {
                                    "refId": {
                                      "type": "string"
                                    },
                                    "gradeCode": {
                                      "type": "string"
                                    },
                                    "sapId": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "refId",
                                    "gradeCode",
                                    "sapId"
                                  ]
                                },
                                "schoolLevel": {
                                  "type": "object",
                                  "properties": {
                                    "levelCode": {
                                      "type": "string"
                                    },
                                    "sapId": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "levelCode",
                                    "sapId"
                                  ]
                                },
                                "session": {
                                  "type": "object",
                                  "properties": {
                                    "refId": {
                                      "type": "string"
                                    },
                                    "sessionCode": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "refId",
                                    "sessionCode"
                                  ]
                                },
                                "periodSession": {
                                  "type": "object",
                                  "properties": {
                                    "refId": {
                                      "type": "string"
                                    },
                                    "periodSessionCode": {
                                      "type": "string"
                                    },
                                    "parameter": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "refId",
                                    "periodSessionCode",
                                    "parameter"
                                  ]
                                },
                                "unoSchool": {
                                  "type": "object",
                                  "properties": {
                                    "refId": {
                                      "type": "string"
                                    },
                                    "schoolIdSystem": {
                                      "type": "string"
                                    },
                                    "sapId": {
                                      "type": "string"
                                    },
                                    "crmId": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "refId",
                                    "schoolIdSystem",
                                    "sapId",
                                    "crmId"
                                  ]
                                }
                              },
                              "required": [
                                "refId",
                                "active",
                                "grade",
                                "schoolLevel",
                                "session",
                                "periodSession",
                                "unoSchool"
                              ]
                            }
                          },
                          "required": [
                            "articleGradePeriod"
                          ]
                        }
                      ]
                    },
                    "articleLevelPrices": {
                      "type": "array",
                      "items": [
                        {
                          "type": "object",
                          "properties": {
                            "articleLevelPrice": {
                              "type": "object",
                              "properties": {
                                "refId": {
                                  "type": "string"
                                },
                                "price": {
                                  "type": "number"
                                },
                                "levelPrice": {
                                  "type": "object",
                                  "properties": {
                                    "refId": {
                                      "type": "string"
                                    },
                                    "levelPriceCode": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "refId",
                                    "levelPriceCode"
                                  ]
                                },
                                "taxPercentage": {
                                  "type": "number"
                                },
                                "currency": {
                                  "type": "object",
                                  "properties": {
                                    "currencyCode": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "currencyCode"
                                  ]
                                }
                              },
                              "required": [
                                "refId",
                                "price",
                                "levelPrice",
                                "taxPercentage",
                                "currency"
                              ]
                            }
                          },
                          "required": [
                            "articleLevelPrice"
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "articleDescription",
                    "articleCode",
                    "articleOrder",
                    "abbreviation",
                    "alternateName",
                    "parameter",
                    "sapId",
                    "ean",
                    "isbn",
                    "alternateEan",
                    "weight",
                    "width",
                    "height",
                    "length",
                    "exclusive",
                    "cdBook",
                    "pages",
                    "collection",
                    "yearPublication",
                    "editorial",
                    "active",
                    "articleAuthor",
                    "subject",
                    "category",
                    "empresa",
                    "articleType",
                    "stamp",
                    "groupArticle",
                    "materialType",
                    "articleGradePeriods",
                    "articleLevelPrices"
                  ]
                }
              },
              "required": [
                "action",
                "data"
              ]
            }
          ]
        }
      },
      "required": [
        "failOnErrors",
        "operations"
      ]
    }
  },
  "required": [
    "articles"
  ]
}

Payload

Code Block
{
    "articles": {
        "failOnErrors": true,
        "operations": [
            {
                "action": "create",
                "data": {
                    "articleDescription": "articulo/12:30/2021-08-23",
                    "articleCode": "codigo/12:30/2021-08-23",
                    "articleOrder": 300,
                    "abbreviation": "articulo/2021-08-23",
                    "alternateName": "articulo/08-23",
                    "parameter": "IPAD",
                    "sapId": "3831524682159",
                    "ean": "9788466846575",
                    "isbn": "9788466829113",
                    "alternateEan": "",
                    "weight": 10,
                    "width": 20,
                    "height": 30,
                    "length": 40,
                    "exclusive": true,
                    "cdBook": "10",
                    "pages": 10,
                    "collection": "coleccion",
                    "yearPublication": "2021",
                    "editorial": "editorial",
                    "active": true,
                    "articleAuthor": {
                        "firstName": "Nombre",
                        "middleName": "Paterno",
                        "lastName": "Materno",
                        "timeZone": {
                            "refId": "00000000-0000-1000-0000-000000000016"
                        },
                        "language": {
                            "refId": "00000000-0000-1000-0000-000000000016"
                        }
                    },
                    "subject": {
                        "subjectCode": "Esp"
                    },
                    "category": {
                        "parameter": "AL"
                    },
                    "empresa": {
                        "refId": "00000000-0000-1000-0000-000000000001"
                    },
                    "articleType": {
                        "parameter": "IPAD"
                    },
                    "stamp": {
                        "stampCode": "SANCAN"
                    },
                    "groupArticle": {
                        "parameter": "PRI"
                    },
                    "materialType": {
                        "parameter": "DI"
                    },
                    "articleGradePeriods": [
                        {
                            "articleGradePeriod": {
                                "refId": "",
                                "active": true,
                                "grade": {
                                    "refId": "",
                                    "gradeCode": "",
                                    "sapId": ""
                                },
                                "schoolLevel": {
                                    "levelCode": "",
                                    "sapId": ""
                                },
                                "session": {
                                    "refId": "",
                                    "sessionCode": ""
                                },
                                "periodSession": {
                                    "refId": "",
                                    "periodSessionCode": "",
                                    "parameter": ""
                                },
                                "unoSchool": {
                                    "refId": "",
                                    "schoolIdSystem": "",
                                    "sapId": "",
                                    "crmId": ""
                                }
                            }
                        }
                    ],
                    "articleLevelPrices": [
                        {
                            "articleLevelPrice": {
                                "refId": "",
                                "price": 0.0000,
                                "levelPrice": {
                                    "refId": "",
                                    "levelPriceCode": ""
                                },
                                "taxPercentage": 0.0000,
                                "currency": {
                                    "currencyCode": ""
                                }
                            }
                        }
                    ]
                }
            }
        ]
    },
    "contract": {
        "operations": [
            {
                "action": "create",
                "data": {
                    "contract": {
                        "contractRefId": "00000000-0000-1000-0000-000000030986",
                        "contract": 3470,
                        "empresaRefId": "00000000-0000-1000-0000-000000000006",
                        "unoSchool": {
                            "refId": "00000000-0000-1000-0000-000000012584"
                        },
                        "session": {
                            "refId": "00000000-0000-1000-0000-000000000681",
                            "sessionCode": "2023-2024"
                        },
                        "contactList": [],
                        "bonus": {
                            "typeBonus": "EFECTIVO",
                            "amountBonus": 12993.99858
                        },
                        "schoolLevelList": [
                            {
                                "schoolLevelCode": "002",
                                "schoolLevelErpId": "002",
                                "customCovers": 0,
                                "participationPercentage": 102,
                                "refundParticipation": 1,
                                "englishCoordinator": 0,
                                "spanishCoordinator": 0,
                                "paymentType": 0,
                                "paymentTypeCode": "",
                                "paymentTypeParameter": "",
                                "gradeList": [
                                    {
                                        "grade": {
                                            "gradeRefId": "00000000-0000-1000-0000-000000000019",
                                            "gradeCode": "1P",
                                            "gradeErpId": 4,
                                            "student": 1,
                                            "unoStudent": 1,
                                            "contractType": "",
                                            "classroom": 0,
                                            "unoClassroom": 0,
                                            "englishTeacher": 0,
                                            "spanishTeacher": 0,
                                            "mathTeacher": 0,
                                            "socialTeacher": 0,
                                            "lectorPlan": 0,
                                            "amountChildrenTeacher": 0
                                        },
                                        "programList": [
                                            {
                                                "action": "create",
                                                "data": {
                                                    "article": {
                                                        "refId": "00000000-0000-1000-0000-000000101938",
                                                        "erpId": "",
                                                        "articleCode": "RS0201",
                                                        "articleType": {
                                                            "articleTypeCode": "SUBP-G"
                                                        }
                                                    },
                                                    "paySchool": 0,
                                                    "payerAmount": 0,
                                                    "proportion": 0,
                                                    "aditional": 0,
                                                    "percentajeDiscount": 0,
                                                    "percentajeTax": 0,
                                                    "price": 0,
                                                    "amount": 1,
                                                    "componentList": [
                                                        {
                                                            "action": "create",
                                                            "data": {
                                                                "subject": {
                                                                    "refId": "00000000-0000-1000-0000-000000006996"
                                                                },
                                                                "article": {
                                                                    "refId": "00000000-0000-1000-0000-000000102081",
                                                                    "erpId": "61099405",
                                                                    "articleCode": "61099405",
                                                                    "articleType": {
                                                                        "articleTypeCode": "LIB",
                                                                        "param": "LIB",
                                                                        "refId": "00000000-0000-1000-0000-000000000054"
                                                                    }
                                                                },
                                                                "grade": {
                                                                    "gradeCode": "1P",
                                                                    "refId": "00000000-0000-1000-0000-000000000019"
                                                                },
                                                                "typeSale": {
                                                                    "typeSaleCode": "VTA"
                                                                },
                                                                "percentajeDiscount": 0,
                                                                "percentajeTax": 0,
                                                                "price": 0,
                                                                "amount": 1
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                }
            }
        ]
    }
}