Patch Partner data
PATCH/partners/{id}
Patch Partner data by id.
Privileges:
- biz-core.manage
Audit event:
- biz.core.v2.partner.patch
Errors:
- BIZ_CORE:PARTNER_NOTFOUND - Partner with given id not found.
- BIZ_PARTNER_CAN_NOT_BE_SUSPENDED_DUE_ITS_STATUS - Business partner can not be suspended due it status.
Validation errors:
- BIZ_CORE:CANT_CHANGE_BIZ_PARTNER_STATUS_NEW_AND_OLD_STATUS_ARE_SAME - Can't change business partner status because new and old status are the same.
- BIZ_CORE:STATUS_CHANGE_IS_NOT_ALLOWED - Status change from <value> to <value> not allowed.
- BIZ_CORE:PARTNER_COUNTRY_NOT_SUPPORTED - Country of the Partner is not supported.
- BIZ_CORE:PARTNERS_LEGAL_ADDRESS_MUST_BE_DEFINED - Please define partners legal address, partner without legal address can not be active.
- BIZ_CORE:PARTNERS_ADDRESS_NOT_FOUND - Partner address not found, partner without legal address can not be active.
- BIZ_CORE:PARTNERS_ADDRESS_BAD_RESPONSE - Partner address bad response, partner without legal address can not be active.
- BIZ_CORE:BIZ_PARTNER_ADDRESS_MUST_BE_PROVIDED - Biz Partner Address must be provided.
- BIZ_CORE:BIZ_PARTNER_ADDRESS_CITY_MUST_BE_PROVIDED - Biz Partner Address city must be provided.
- BIZ_CORE:PARTNER_COUNTRY_IS_DIFFERENT - Country of the Partner is different from legal address country.
- BIZ_CORE:PARTNERS_PRODUCTS_MUST_BE_DEFINED - Please define products for partner, partner without products can not be active
- invalid value -Status can not be empty value
Request
Responses
- 200
- 409
- default
Partners status changed successfully
Unable to delete Partner due it's instance role or relations (could be with pricelists, billings, balances, connections, coOwner, nGage)
biz partner (bizPartnerId = xxxx) can have pricelists as customer and supplier for products SMS and MNP
API endpoint for customerSMSPricelists: /bulk/pricelists/sms/selling?eq(customerId)=xxxx&all=yes API endpoint for supplierSMSPricelists: /bulk/pricelists/sms/buying?eq(supplierId)=xxxx&all=yes API endpoint for customerMNPPricelists: /bulk/pricelists/mnp/selling?eq(customerId)=xxxx&all=yes API endpoint for supplierMNPPricelists: /bulk/pricelists/mnp/buying?eq(supplierId)=xxxx&all=yes for activate/deactivate biz partner additional parameter must be sent on URI (&neq(status)=inactive)
biz partner (bizPartnerId = xxxx) can have total balances as customer and supplier for products SMS and MNP
API endpoint for customerSMSTotalBalances: /bulk/billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes API endpoint for supplierSMSTotalBalances: /bulk/gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes API endpoint for customerMNPTotalBalances: /bulk/mnp-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes API endpoint for supplierMNPTotalBalances: /bulk/mnp-gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes for activate/deactivate biz partner additional parameter must be sent on URI (&neq(status)=inactive)
biz partner (bizPartnerId = xxxx) can have billing accounts as customer and supplier for products SMS and MNP
API endpoint for customerSMSBillingAccounts: /bulk/billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes API endpoint for supplierSMSBillingAccounts: /bulk/gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes API endpoint for customerMNPBillingAccounts: /bulk/mnp-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes API endpoint for supplierMNPBillingAccounts: /bulk/mnp-gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes for activate/deactivate biz partner additional parameter must be sent on URI (&neq(status)=inactive)
biz partner (bizPartnerId = xxxx) can have connections as customer and supplier for products SMS and MNP
API endpoint for customerSMSConnections: /bulk/sms-accounts/v1/accounts?eq(customerId)=xxxx&all=yes API endpoint for supplierSMSConnections: /bulk/gates/v1/out-gates?eq(supplierId)=xxxx&all=yes API endpoint for customerMNPConnections: /bulk/mnp-accounts/v1/out-gates?eq(customerId)=xxxx&all=yes API endpoint for supplierMNPConnections: /bulk/mnp-supplier-accounts/v1/supplier-accounts?eq(supplierId)=xxxx&all=yes for activate/deactivate biz partner additional parameter must be sent on URI (&neq(status)=inactive)
biz partner (bizPartnerId = xxxx) can have coOwners
API endpoint for bizPartnerCoOwner: /biz-core/v2/partners?ownerBpId=xxxx
biz partner (bizPartnerId = xxxx) can have NGages linked
API endpoint for bizPartnerNGages: /news/v1/services?partnerId=xxxx for activate/deactivate biz partner additional parameter must be sent on URI (&neq(status)=inactive)
Example of JSON response for status code 409 ``` json {
"error": {
"code": "INVALID-PARAMETERS",
"message": "Invalid parameters",
"items": [
{
"name": "customerSMSConnections",
"message": "customerSMSConnections",
"description": "ID: 1547 Name: 3396_VOICES_EUR; ID: 1639 Name: 3396_VOICES; ID: 1686 Name: Test Account Eco;"
},
{
"name": "supplierSMSConnections",
"message": "supplierSMSConnections",
"description": "ID: 369 Name: ODTTELEKOM;"
},
{
"name": "supplierSMSPricelists",
"message": "supplierSMSPricelists",
"description": "ID: 1105 Name: AV Pack PL 1; ID: 1110 Name: AV Pack PL 1; ID: 1107 Name: AV Pack PL 1; "
},
{
"name": "customerSMSPricelists",
"message": "customerSMSPricelists",
"description": "ID: 469 Name: 1061_ECO; ID: 470 Name: 1061_FIXID; ID: 1038 Name: 1061_SUNRISE; ID: 1729 Name: TP-PL; "
},
{
"name": "customerSMSTotalBalances",
"message": "customerSMSTotalBalances",
"description": "ID: 37 Name: Cortex Postpaid CHF; ID: 38 Name: Cortex Postpaid EUR; ID: 135 Name: fdg; ID: 143 Name: Cortex Prepaid EUR; "
},
{
"name": "supplierSMSTotalBalances",
"message": "supplierSMSTotalBalances",
"description": "ID: 33\tName: Cortex Communications AG postpaid CHF\n"
},
{
"name": "customerSMSBillingAccount",
"message": "customerSMSBillingAccount",
"description": "ID: 41 Name: 3396_VOICES_EUR; ID: 42 Name: 3396_VOICES; ID: 43 Name: 1061_FIXID; "
}
]
}
}
unexpected error