Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (34 loc) · 1.28 KB

UsernamesApi.md

File metadata and controls

56 lines (34 loc) · 1.28 KB

Bfwd::UsernamesApi

All URIs are relative to https://localhost:8080/RestAPI

Method HTTP request Description
create_username POST /usernames Create a username.

create_username

UsernamePagedMetadata create_username(username)

Create a username.

{"nickname":"Create","request":"createUsernameRequest.html","response":"createUsernameResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::UsernamesApi.new

username = Bfwd::Username.new # Username | The username object to be created.


begin
  #Create a username.
  result = api_instance.create_username(username)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling UsernamesApi->create_username: #{e}"
end

Parameters

Name Type Description Notes
username Username The username object to be created.

Return type

UsernamePagedMetadata

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: text/xml, application/xml, application/json; charset=utf-8