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
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:
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:
apiProvFuncRole:
regInfo:
failReason:
regSec:
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
Name | Type | Format | Description |
---|---|---|---|
Location | String | An alternative URI of the resource. |
Status: 400 - Bad request
Represents additional information and details on an error response.
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.
Status: 401 - Unauthorized
Represents additional information and details on an error response.
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.
Status: 403 - Forbidden
Represents additional information and details on an error response.
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.
Status: 404 - Not Found
Represents additional information and details on an error response.
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.
Status: 411 - Length Required
Represents additional information and details on an error response.
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.
Status: 413 - Payload Too Large
Represents additional information and details on an error response.
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.
Status: 415 - Unsupported Media Type
Represents additional information and details on an error response.
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.
Status: 429 - Too Many Requests
Represents additional information and details on an error response.
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.
Status: 500 - Internal Server Error
Represents additional information and details on an error response.
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.
Status: 503 - Service Unavailable
Represents additional information and details on an error response.
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.