User Tools

Site Tools


api:mvnoroamingpartners:update

API : MVNO roaming partners Update

Introduction

This request creates or updates several roaming partners at once. It is used together with Upload: upload the operator's sheet, then send the partners it returned to this endpoint to save them.

Request

URL https://api.telecomx.dk/mvno/roamingpartner/update
Method POST
Access level RESELLER_ADMIN with the FINANCE employee feature.
ADMIN.
Body Array The partners to create or update, see definition below. An empty array changes nothing.
Field Type Description
_id String The operator's ID code. A partner with this ID is updated; otherwise it is created.
operator String [optional] Operator name. Defaults to the operator code.
country String [optional] Name of the country the operator is stored with.
countryCode String ISO 3166 two-letter country code.
code Number Operator code as used in the billing data; a whole number, 0 or more.
region String [optional] Region the country belongs to. Allowed values are euNordic, restOfEurope, world1, world2, world3.

A field that is not sent is left as it is on an existing partner.

Query examples

https://api.telecomx.dk/mvno/roamingpartner/update
[
  {
    _id: 'XMPLA',
    operator: 'Example Mobile',
    country: 'Sweden',
    countryCode: 'SE',
    code: 24099,
    region: 'euNordic'
  }
]

Response

JSON object
success true

Example

{
  success: true
}

Errors

Error code Message Description
422 <property> Invalid input for the named property - the request body, query or URL parameter failed validation
404 <property> A required property is missing from the request
403 access_denied A minimum access level of 'RESELLER_ADMIN' required
403 access_denied Employees does not have the required feature FINANCE
500 internal_error <Unspecified>
api/mvnoroamingpartners/update.txt · Last modified: by Mikkel Meerwaldt Jørgensen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki