BokaMera.API.Host

CreateApiKeySuperAdminUser

**Requires Authentication**
Required role:	superadmin

The following routes are available for this service:
POST	/superadmin/apikey	Creates an api key for the customer.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ApiKeySuperAdminResponse implements JsonSerializable
{
    public function __construct(
        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $CompanyId='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $ApiKey='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $Notes='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $InternalNotes=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        if (isset($o['InternalNotes'])) $this->InternalNotes = $o['InternalNotes'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->InternalNotes)) $o['InternalNotes'] = $this->InternalNotes;
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
class CreateApiKeySuperAdminUser implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description Enter the companyId for the customer */
        // @ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
        /** @var string */
        public string $CompanyId='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $FirstName='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $LastName='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $ContactEmail='',

        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $ContactPhone='',

        // @ApiMember()
        /** @var string|null */
        public ?string $Notes=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['ContactEmail'])) $this->ContactEmail = $o['ContactEmail'];
        if (isset($o['ContactPhone'])) $this->ContactPhone = $o['ContactPhone'];
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->ContactEmail)) $o['ContactEmail'] = $this->ContactEmail;
        if (isset($this->ContactPhone)) $o['ContactPhone'] = $this->ContactPhone;
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateApiKeySuperAdminUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /superadmin/apikey HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateApiKeySuperAdminUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ContactEmail>String</ContactEmail>
  <ContactPhone>String</ContactPhone>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Notes>String</Notes>
</CreateApiKeySuperAdminUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiKeySuperAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <InternalNotes>String</InternalNotes>
  <Notes>String</Notes>
</ApiKeySuperAdminResponse>