CAPIF_API_Provider_Management_API

Default

registrationsPost

Registers a new API Provider domain with API provider domain functions profiles.

/registrations

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/api-provider-management/v1/registrations" \
 -d '{
  "apiProvFuncs" : [ {
    "apiProvFuncId" : "apiProvFuncId",
    "apiProvFuncInfo" : "apiProvFuncInfo",
    "regInfo" : {
      "apiProvCert" : "apiProvCert",
      "apiProvPubKey" : "apiProvPubKey"
    },
    "apiProvFuncRole" : "AEF"
  }, {
    "apiProvFuncId" : "apiProvFuncId",
    "apiProvFuncInfo" : "apiProvFuncInfo",
    "regInfo" : {
      "apiProvCert" : "apiProvCert",
      "apiProvPubKey" : "apiProvPubKey"
    },
    "apiProvFuncRole" : "AEF"
  } ],
  "failReason" : "failReason",
  "regSec" : "regSec",
  "apiProvDomId" : "apiProvDomId",
  "apiProvDomInfo" : "apiProvDomInfo",
  "suppFeat" : "suppFeat"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsPost");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 

try {
    final result = await api_instance.registrationsPost(aPIProviderEnrolmentDetails);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registrationsPost: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsPost");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
APIProviderEnrolmentDetails *aPIProviderEnrolmentDetails = ; // 

[apiInstance registrationsPostWith:aPIProviderEnrolmentDetails
              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CapifApiProviderManagementApi = require('capif_api_provider_management_api');

// Create an instance of the API class
var api = new CapifApiProviderManagementApi.DefaultApi()
var aPIProviderEnrolmentDetails = ; // {APIProviderEnrolmentDetails} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registrationsPost(aPIProviderEnrolmentDetails, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registrationsPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 

            try {
                APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.registrationsPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

try {
    $result = $api_instance->registrationsPost($aPIProviderEnrolmentDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->registrationsPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $aPIProviderEnrolmentDetails = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetails->new(); # APIProviderEnrolmentDetails | 

eval {
    my $result = $api_instance->registrationsPost(aPIProviderEnrolmentDetails => $aPIProviderEnrolmentDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->registrationsPost: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
aPIProviderEnrolmentDetails =  # APIProviderEnrolmentDetails | 

try:
    api_response = api_instance.registrations_post(aPIProviderEnrolmentDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->registrationsPost: %s\n" % e)

extern crate DefaultApi;

pub fn main() {
    let aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails

    let mut context = DefaultApi::Context::default();
    let result = client.registrationsPost(aPIProviderEnrolmentDetails, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name Description

Name	Description
aPIProviderEnrolmentDetails *	{ Represents an API provider domain's enrolment details. Required: regSec apiProvDomId: string API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API Management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. Read Only apiProvDomInfo: string Generic information related to the API provider domain such as details of the API provider applications. apiProvFuncs: [ (1..∞) A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully. { Represents API provider domain function's details. Required: apiProvFuncRole,regInfo apiProvFuncId: string API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses. apiProvFuncInfo: string Generic information related to the API provider domain function such as details of the API provider applications. apiProvFuncRole: string Possible values are: AEF: API provider function is API Exposing Function. APF: API provider function is API Publishing Function. AMF: API Provider function is API Management Function. Enum: `AEF`, `APF`, `AMF` regInfo: { Represents registration information of an individual API provider domain function. Required: apiProvPubKey apiProvCert: string API provider domain function's client certificate apiProvPubKey: string Public Key of API Provider domain function. ] failReason: string Registration or update specific failure information of failed API provider domain function registrations.Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails. regSec: string Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP POST request from API management function to CAPIF core function for API provider domain registration. suppFeat: string A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. Pattern: ^[A-Fa-f0-9]*$

aPIProviderEnrolmentDetails *

{

Represents an API provider domain's enrolment details.

Required: regSec

apiProvDomId:

string

API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API Management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.

Read Only

apiProvDomInfo:

string

Generic information related to the API provider domain such as details of the API provider applications.

apiProvFuncs:

[ (1..∞)

A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully.

{

Represents API provider domain function's details.

Required: apiProvFuncRole,regInfo

apiProvFuncId:

string

API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses.

apiProvFuncInfo:

string

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvFuncRole:

string

Possible values are:

AEF: API provider function is API Exposing Function.
APF: API provider function is API Publishing Function.
AMF: API Provider function is API Management Function.

Enum: AEF, APF, AMF

regInfo:

{

Represents registration information of an individual API provider domain function.

Required: apiProvPubKey

apiProvCert:

string

API provider domain function's client certificate

apiProvPubKey:

string

Public Key of API Provider domain function.

]

failReason:

string

Registration or update specific failure information of failed API provider domain function registrations.Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails.

regSec:

string

Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP POST request from API management function to CAPIF core function for API provider domain registration.

suppFeat:

string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

Responses

Status: 201 - API provider domain registered successfully

Schema
Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

registrationsRegistrationIdDelete

Deregisters API provider domain by deleting API provider domain and functions.

/registrations/{registrationId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://example.com/api-provider-management/v1/registrations/{registrationId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.

        try {
            apiInstance.registrationsRegistrationIdDelete(registrationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdDelete");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String registrationId = new String(); // String | String identifying an registered API provider domain resource.

try {
    final result = await api_instance.registrationsRegistrationIdDelete(registrationId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registrationsRegistrationIdDelete: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.

        try {
            apiInstance.registrationsRegistrationIdDelete(registrationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdDelete");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = registrationId_example; // String identifying an registered API provider domain resource. (default to null)

[apiInstance registrationsRegistrationIdDeleteWith:registrationId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CapifApiProviderManagementApi = require('capif_api_provider_management_api');

// Create an instance of the API class
var api = new CapifApiProviderManagementApi.DefaultApi()
var registrationId = registrationId_example; // {String} String identifying an registered API provider domain resource.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.registrationsRegistrationIdDelete(registrationId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registrationsRegistrationIdDeleteExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = registrationId_example;  // String | String identifying an registered API provider domain resource. (default to null)

            try {
                apiInstance.registrationsRegistrationIdDelete(registrationId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.registrationsRegistrationIdDelete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.

try {
    $api_instance->registrationsRegistrationIdDelete($registrationId);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->registrationsRegistrationIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = registrationId_example; # String | String identifying an registered API provider domain resource.

eval {
    $api_instance->registrationsRegistrationIdDelete(registrationId => $registrationId);
};
if ($@) {
    warn "Exception when calling DefaultApi->registrationsRegistrationIdDelete: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = registrationId_example # String | String identifying an registered API provider domain resource. (default to null)

try:
    api_instance.registrations_registration_id_delete(registrationId)
except ApiException as e:
    print("Exception when calling DefaultApi->registrationsRegistrationIdDelete: %s\n" % e)

extern crate DefaultApi;

pub fn main() {
    let registrationId = registrationId_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.registrationsRegistrationIdDelete(registrationId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
registrationId*	String String identifying an registered API provider domain resource. Required

Responses

Status: 204 - The API provider domain matching registrationId is deleted.

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

registrationsRegistrationIdPut

Updates an API provider domain's registration details.

/registrations/{registrationId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/api-provider-management/v1/registrations/{registrationId}" \
 -d '{
  "apiProvFuncs" : [ {
    "apiProvFuncId" : "apiProvFuncId",
    "apiProvFuncInfo" : "apiProvFuncInfo",
    "regInfo" : {
      "apiProvCert" : "apiProvCert",
      "apiProvPubKey" : "apiProvPubKey"
    },
    "apiProvFuncRole" : "AEF"
  }, {
    "apiProvFuncId" : "apiProvFuncId",
    "apiProvFuncInfo" : "apiProvFuncInfo",
    "regInfo" : {
      "apiProvCert" : "apiProvCert",
      "apiProvPubKey" : "apiProvPubKey"
    },
    "apiProvFuncRole" : "AEF"
  } ],
  "failReason" : "failReason",
  "regSec" : "regSec",
  "apiProvDomId" : "apiProvDomId",
  "apiProvDomInfo" : "apiProvDomInfo",
  "suppFeat" : "suppFeat"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdPut");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String registrationId = new String(); // String | String identifying an registered API provider domain resource.
final APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 

try {
    final result = await api_instance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registrationsRegistrationIdPut: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdPut");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = registrationId_example; // String identifying an registered API provider domain resource. (default to null)
APIProviderEnrolmentDetails *aPIProviderEnrolmentDetails = ; // 

[apiInstance registrationsRegistrationIdPutWith:registrationId
    aPIProviderEnrolmentDetails:aPIProviderEnrolmentDetails
              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CapifApiProviderManagementApi = require('capif_api_provider_management_api');

// Create an instance of the API class
var api = new CapifApiProviderManagementApi.DefaultApi()
var registrationId = registrationId_example; // {String} String identifying an registered API provider domain resource.
var aPIProviderEnrolmentDetails = ; // {APIProviderEnrolmentDetails} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registrationsRegistrationIdPutExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = registrationId_example;  // String | String identifying an registered API provider domain resource. (default to null)
            var aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 

            try {
                APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.registrationsRegistrationIdPut: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
$aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 

try {
    $result = $api_instance->registrationsRegistrationIdPut($registrationId, $aPIProviderEnrolmentDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->registrationsRegistrationIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = registrationId_example; # String | String identifying an registered API provider domain resource.
my $aPIProviderEnrolmentDetails = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetails->new(); # APIProviderEnrolmentDetails | 

eval {
    my $result = $api_instance->registrationsRegistrationIdPut(registrationId => $registrationId, aPIProviderEnrolmentDetails => $aPIProviderEnrolmentDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->registrationsRegistrationIdPut: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = registrationId_example # String | String identifying an registered API provider domain resource. (default to null)
aPIProviderEnrolmentDetails =  # APIProviderEnrolmentDetails | 

try:
    api_response = api_instance.registrations_registration_id_put(registrationId, aPIProviderEnrolmentDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->registrationsRegistrationIdPut: %s\n" % e)

extern crate DefaultApi;

pub fn main() {
    let registrationId = registrationId_example; // String
    let aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails

    let mut context = DefaultApi::Context::default();
    let result = client.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
registrationId*	String String identifying an registered API provider domain resource. Required

Body parameters

Name Description

Name	Description
aPIProviderEnrolmentDetails *	Representation of the API provider domain registration details to be updated in CAPIF core function. { Represents an API provider domain's enrolment details. Required: regSec apiProvDomId: string API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API Management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. Read Only apiProvDomInfo: string Generic information related to the API provider domain such as details of the API provider applications. apiProvFuncs: [ (1..∞) A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully. { Represents API provider domain function's details. Required: apiProvFuncRole,regInfo apiProvFuncId: string API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses. apiProvFuncInfo: string Generic information related to the API provider domain function such as details of the API provider applications. apiProvFuncRole: string Possible values are: AEF: API provider function is API Exposing Function. APF: API provider function is API Publishing Function. AMF: API Provider function is API Management Function. Enum: `AEF`, `APF`, `AMF` regInfo: { Represents registration information of an individual API provider domain function. Required: apiProvPubKey apiProvCert: string API provider domain function's client certificate apiProvPubKey: string Public Key of API Provider domain function. ] failReason: string Registration or update specific failure information of failed API provider domain function registrations.Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails. regSec: string Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP POST request from API management function to CAPIF core function for API provider domain registration. suppFeat: string A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. Pattern: ^[A-Fa-f0-9]*$

aPIProviderEnrolmentDetails *

Representation of the API provider domain registration details to be updated in CAPIF core function.

{

Represents an API provider domain's enrolment details.

Required: regSec

apiProvDomId:

string

Read Only

apiProvDomInfo:

string

Generic information related to the API provider domain such as details of the API provider applications.

apiProvFuncs:

[ (1..∞)

{

Represents API provider domain function's details.

Required: apiProvFuncRole,regInfo

apiProvFuncId:

string

apiProvFuncInfo:

string

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvFuncRole:

string

Possible values are:

AEF: API provider function is API Exposing Function.
APF: API provider function is API Publishing Function.
AMF: API Provider function is API Management Function.

Enum: AEF, APF, AMF

regInfo:

{

Represents registration information of an individual API provider domain function.

Required: apiProvPubKey

apiProvCert:

string

API provider domain function's client certificate

apiProvPubKey:

string

Public Key of API Provider domain function.

]

failReason:

string

regSec:

string

suppFeat:

string

Pattern: ^[A-Fa-f0-9]*$

Responses

Status: 200 - API provider domain registration details updated successfully.

Schema

{

Represents an API provider domain's enrolment details.

Required: regSec

apiProvDomId:

string

Read Only

apiProvDomInfo:

string

Generic information related to the API provider domain such as details of the API provider applications.

apiProvFuncs:

[ (1..∞)

{

Represents API provider domain function's details.

Required: apiProvFuncRole,regInfo

apiProvFuncId:

string

apiProvFuncInfo:

string

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvFuncRole:

string

Possible values are:

AEF: API provider function is API Exposing Function.
APF: API provider function is API Publishing Function.
AMF: API Provider function is API Management Function.

Enum: AEF, APF, AMF

regInfo:

{

Represents registration information of an individual API provider domain function.

Required: apiProvPubKey

apiProvCert:

string

API provider domain function's client certificate

apiProvPubKey:

string

Public Key of API Provider domain function.

]

failReason:

string

regSec:

string

suppFeat:

string

Pattern: ^[A-Fa-f0-9]*$

Status: 204 - No Content

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

IndividualAPIProviderEnrolmentDetails

modifyIndApiProviderEnrolment

Modify an individual API provider details.

/registrations/{registrationId}

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/merge-patch+json" \
 "https://example.com/api-provider-management/v1/registrations/{registrationId}" \
 -d 'Custom MIME type example not yet supported: application/merge-patch+json'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndividualAPIProviderEnrolmentDetailsApi;

import java.io.File;
import java.util.*;

public class IndividualAPIProviderEnrolmentDetailsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndividualAPIProviderEnrolmentDetailsApi apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
        String registrationId = registrationId_example; // String | 
        APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndividualAPIProviderEnrolmentDetailsApi#modifyIndApiProviderEnrolment");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String registrationId = new String(); // String | 
final APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = new APIProviderEnrolmentDetailsPatch(); // APIProviderEnrolmentDetailsPatch | 

try {
    final result = await api_instance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->modifyIndApiProviderEnrolment: $e\n');
}

import org.openapitools.client.api.IndividualAPIProviderEnrolmentDetailsApi;

public class IndividualAPIProviderEnrolmentDetailsApiExample {
    public static void main(String[] args) {
        IndividualAPIProviderEnrolmentDetailsApi apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
        String registrationId = registrationId_example; // String | 
        APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 

        try {
            APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndividualAPIProviderEnrolmentDetailsApi#modifyIndApiProviderEnrolment");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
IndividualAPIProviderEnrolmentDetailsApi *apiInstance = [[IndividualAPIProviderEnrolmentDetailsApi alloc] init];
String *registrationId = registrationId_example; //  (default to null)
APIProviderEnrolmentDetailsPatch *aPIProviderEnrolmentDetailsPatch = ; // 

[apiInstance modifyIndApiProviderEnrolmentWith:registrationId
    aPIProviderEnrolmentDetailsPatch:aPIProviderEnrolmentDetailsPatch
              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var CapifApiProviderManagementApi = require('capif_api_provider_management_api');

// Create an instance of the API class
var api = new CapifApiProviderManagementApi.IndividualAPIProviderEnrolmentDetailsApi()
var registrationId = registrationId_example; // {String} 
var aPIProviderEnrolmentDetailsPatch = ; // {APIProviderEnrolmentDetailsPatch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyIndApiProviderEnrolmentExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
            var registrationId = registrationId_example;  // String |  (default to null)
            var aPIProviderEnrolmentDetailsPatch = new APIProviderEnrolmentDetailsPatch(); // APIProviderEnrolmentDetailsPatch | 

            try {
                APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndividualAPIProviderEnrolmentDetailsApi.modifyIndApiProviderEnrolment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndividualAPIProviderEnrolmentDetailsApi();
$registrationId = registrationId_example; // String | 
$aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 

try {
    $result = $api_instance->modifyIndApiProviderEnrolment($registrationId, $aPIProviderEnrolmentDetailsPatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IndividualAPIProviderEnrolmentDetailsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndividualAPIProviderEnrolmentDetailsApi->new();
my $registrationId = registrationId_example; # String | 
my $aPIProviderEnrolmentDetailsPatch = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetailsPatch->new(); # APIProviderEnrolmentDetailsPatch | 

eval {
    my $result = $api_instance->modifyIndApiProviderEnrolment(registrationId => $registrationId, aPIProviderEnrolmentDetailsPatch => $aPIProviderEnrolmentDetailsPatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.IndividualAPIProviderEnrolmentDetailsApi()
registrationId = registrationId_example # String |  (default to null)
aPIProviderEnrolmentDetailsPatch =  # APIProviderEnrolmentDetailsPatch | 

try:
    api_response = api_instance.modify_ind_api_provider_enrolment(registrationId, aPIProviderEnrolmentDetailsPatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: %s\n" % e)

extern crate IndividualAPIProviderEnrolmentDetailsApi;

pub fn main() {
    let registrationId = registrationId_example; // String
    let aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch

    let mut context = IndividualAPIProviderEnrolmentDetailsApi::Context::default();
    let result = client.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
registrationId*	String Required

Body parameters

Name Description

Name	Description
aPIProviderEnrolmentDetailsPatch *	{ Represents an API provider domain's enrolment details. apiProvDomInfo: string Generic information related to the API provider domain such as details of the API provider applications. apiProvFuncs: [ (1..∞) A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. { Represents API provider domain function's details. Required: apiProvFuncRole,regInfo apiProvFuncId: string API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses. apiProvFuncInfo: string Generic information related to the API provider domain function such as details of the API provider applications. apiProvFuncRole: string Possible values are: AEF: API provider function is API Exposing Function. APF: API provider function is API Publishing Function. AMF: API Provider function is API Management Function. Enum: `AEF`, `APF`, `AMF` regInfo: { Represents registration information of an individual API provider domain function. Required: apiProvPubKey apiProvCert: string API provider domain function's client certificate apiProvPubKey: string Public Key of API Provider domain function. ]

aPIProviderEnrolmentDetailsPatch *

{

Represents an API provider domain's enrolment details.

apiProvDomInfo:

string

Generic information related to the API provider domain such as details of the API provider applications.

apiProvFuncs:

[ (1..∞)

{

Represents API provider domain function's details.

Required: apiProvFuncRole,regInfo

apiProvFuncId:

string

apiProvFuncInfo:

string

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvFuncRole:

string

Possible values are:

AEF: API provider function is API Exposing Function.
APF: API provider function is API Publishing Function.
AMF: API Provider function is API Management Function.

Enum: AEF, APF, AMF

regInfo:

{

Represents registration information of an individual API provider domain function.

Required: apiProvPubKey

apiProvCert:

string

API provider domain function's client certificate

apiProvPubKey:

string

Public Key of API Provider domain function.

]

Responses

Status: 200 - The definition of the service API is modified successfully and a representation of the updated service API is returned in the request body.

Schema

{

Represents an API provider domain's enrolment details.

Required: regSec

apiProvDomId:

string

Read Only

apiProvDomInfo:

string

Generic information related to the API provider domain such as details of the API provider applications.

apiProvFuncs:

[ (1..∞)

{

Represents API provider domain function's details.

Required: apiProvFuncRole,regInfo

apiProvFuncId:

string

apiProvFuncInfo:

string

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvFuncRole:

string

Possible values are:

AEF: API provider function is API Exposing Function.
APF: API provider function is API Publishing Function.
AMF: API Provider function is API Management Function.

Enum: AEF, APF, AMF

regInfo:

{

Represents registration information of an individual API provider domain function.

Required: apiProvPubKey

apiProvCert:

string

API provider domain function's client certificate

apiProvPubKey:

string

Public Key of API Provider domain function.

]

failReason:

string

regSec:

string

suppFeat:

string

Pattern: ^[A-Fa-f0-9]*$

Status: 204 - No Content. The definition of the service API is modified successfully.

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

{

Represents the description of invalid parameters, for a request rejected due to invalid parameters.

Required: param

param:

string

Attribute's name encoded as a JSON Pointer, or header's name.

reason:

string

A human-readable reason, e.g. "must be a positive integer".

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

CAPIF_API_Provider_Management_API

API and SDK Documentation

Default

registrationsPost

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 201 - API provider domain registered successfully

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

registrationsRegistrationIdDelete

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 204 - The API provider domain matching registrationId is deleted.

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

registrationsRegistrationIdPut

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 200 - API provider domain registration details updated successfully.

Status: 204 - No Content

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

IndividualAPIProviderEnrolmentDetails

modifyIndApiProviderEnrolment

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 200 - The definition of the service API is modified successfully and a representation of the updated service API is returned in the request body.

Status: 204 - No Content. The definition of the service API is modified successfully.

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error