Searching...

Matching results

    Operator Connection

    A connections describes necessary information to be provided in order to connect with the operator services. This information will be provided creating an account.

    Read only fields are computed by AirVantage and can only be seen on response fragments sent by find request.

    Field Description Read Only Type
    uid Connections's unique identifier. true uid
    name Connections's name. true string
    operators List of operators which are compatible with this connection. See Get Operators. true enum
    communicationIdentifiers The list of subscription identifiers which are required in order to use the operator services.
    Possible values are : Identifier, MobileNumber, NetworkIdentifier
    true string array
    supportedSmsTypes Says which kind of SMS are supported.
    Possible values are: Text, Binary
    true enum
    accountParameters Necessary parameters to connect successfully with the operator services. true parameter array
    accountParameters.name Parameter's name true string
    accountParameters.type Parameter's type. Possible types are : boolean, date, double, int, long, string true string
    accountParameters.optional Is it optional? true boolean
    accountParameters.restricted Is it restricted (only visible by an administrator) ? true boolean
    accountParameters.constraints Possible values may have constraints. true
    customizableTypes Description of the customizable types defined for this connection. A description of a custom type contains the following information:
    • The name
    • The expected type of the values. Possible types are : boolean, date, double, int, long, string
    • The constraints of the values

    Authorized values for each custom types are defined during the creation of a OperatorAccount.
    true object array
    operations Available services for this connection. true operation array
    operations.name Operation's name. true string
    operations.parameters.name Parameter's name true string
    operations.parameters.type Parameter's type. Possible types are : boolean, date, double, int, long, string or a value defined in customTypes true string
    operations.parameters.optional Is this parameter optional? true boolean
    operations.parameters.constraints Possible values may have constraints. true
    operations.parameters.cardinality How many times this parameter is expected. true int

    This is a complete representation of an Operation Connection. This fragment is returned by the find request. Please refer to the fields section to have a detailed explanation of each field.

    {
       "uid": "",
       "name": "",
       "operators": [],
       "communicationIdentifiers": [],
       "supportedSmsTypes": [  "Text", "Binary" ],
       "accountParameters": [
          {
             "name": "",
             "type": "",
             "optional": ,
             "restricted": ,
             "constraints": 
          }],
       "customizableTypes":       [],
       "operations": [
            {
                "name": "",
                "parameters": [ 
                   {
                    "name": "",
                    "type": "",
                    "constraints": ,
                    "optional": ,
                    "cardinality": {
                       "min": ,
                       "max": 
                     }
                   }]
            }]
    }

    /api/v1/operators/connections

    Returns a paginated list of available operators connections.

    It is possible to restrain the result list using criteria parameters.

    The fields parameter has to be defined in order to specify the attributes of the operator connection which will be returned.
    If fields parameter is missing, only the following attributes of the operator connection are returned : uid, name, operator.

    More information about paging, filtering, and sorting here

    Request

    GET https://na.airvantage.net/api/v1/operatorconnections?fields=uid,name,operator,operations

    Response
    200 OK

    HTTP/1.1 200 OK
    Content-Type: application/json
    [
          {
          "uid": "5b909116ee1749559c6941766168dae5",
          "name": "Sample Operator Connection",
          "operators": ["VODAFONE"],
          "operations":       [
                      {
                "name": "Activate",
                "parameters": [
                   "name": "City",
                   "type": "CityCode",
                   "constraints": null,
                   "optional": true,
                   "cardinality": {
                      "min": 0,
                      "max": 1
                   }
                ]
             },
                      {
                "name": "Restore",
                "parameters": []
             },
                      {
                "name": "Suspend",
                "parameters": []
             },
                      {
                "name": "Synchronize",
                "parameters": []
             }
          ]
       }
    ]
    Name Description Use Default Type Operand
    uid Return the operator connection whose uid match with the given one. optional null uid =
    operator Return all operator connections matching the given operator. optional null string =
    name Return all operator connections whose name contains the given string. optional null string like
    company Set the context company. optional caller's company uid =
    HTTP Method GET
    Requires Authentication Yes
    Rate Limited Yes
    Headers None
    Permissions None
    Fields uid, name, operators, supportedSmsTypes, communicationIdentifiers, customizableTypes, operations, accountParameters
    TOP