Required role: | superadmin |
GET | /superadmin/apikey/{CompanyId} | Get an api key for the customer. |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiKeySuperAdminResponse:
# @ApiMember(IsRequired=true)
company_id: Optional[str] = None
# @ApiMember(IsRequired=true)
api_key: Optional[str] = None
# @ApiMember(IsRequired=true)
notes: Optional[str] = None
# @ApiMember(IsRequired=true)
internal_notes: Optional[str] = None
# @ApiResponse(Description="", StatusCode=400)
# @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApiKeySuperAdminUser(ICompany):
# @ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
company_id: Optional[str] = None
"""
Enter the companyId for the customer
"""
Python GetApiKeySuperAdminUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/apikey/{CompanyId} HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
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>