POST api/v2/locations/{locationId}/partnerdetails/{partnerId}/enrollcamera?partitionId={partitionId}

Fix TC2-24107 Return Enrollment details for a Partner Camera Equivalent SOAP API : EnrollPartnerCamera

Request Information

URI Parameters

NameDescriptionTypeAdditional information
partnerId

integer

Required

locationId

integer

Required

partitionId

integer

None.

Body Parameters

DeviceInfo
NameDescriptionTypeAdditional information
pkicertinfo

string

None.

PartnerCameraSerialNumber

string

None.

PartnerCameraName

string

None.

PartnerCameraMacAddress

string

None.

PartnerCameraType

string

None.

FirmwareVersion

string

None.

OldCertFlowRequired

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "pkicertinfo": "sample string 1",
  "PartnerCameraSerialNumber": "sample string 2",
  "PartnerCameraName": "sample string 3",
  "PartnerCameraMacAddress": "sample string 4",
  "PartnerCameraType": "sample string 5",
  "FirmwareVersion": "sample string 6",
  "OldCertFlowRequired": true
}

application/xml, text/xml

Sample:
<DeviceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <FirmwareVersion>sample string 6</FirmwareVersion>
  <OldCertFlowRequired>true</OldCertFlowRequired>
  <PartnerCameraMacAddress>sample string 4</PartnerCameraMacAddress>
  <PartnerCameraName>sample string 3</PartnerCameraName>
  <PartnerCameraSerialNumber>sample string 2</PartnerCameraSerialNumber>
  <PartnerCameraType>sample string 5</PartnerCameraType>
  <pkicertinfo>sample string 1</pkicertinfo>
</DeviceInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EnrollmentResults

EnrollmentResults
NameDescriptionTypeAdditional information
EnrollmentDetails

EnrollmentDetails

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EnrollmentDetails": {
    "RegistrationID": "sample string 1",
    "ProvisioningServerThumbprint": "sample string 2",
    "ProvisioningServiceUri": "sample string 3"
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<EnrollmentResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <EnrollmentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.PartnerCamera">
    <d2p1:AdditionalInfo>sample string 4</d2p1:AdditionalInfo>
    <d2p1:ProvisioningServerThumbprint>sample string 2</d2p1:ProvisioningServerThumbprint>
    <d2p1:ProvisioningServiceUri>sample string 3</d2p1:ProvisioningServiceUri>
    <d2p1:RegistrationID>sample string 1</d2p1:RegistrationID>
  </EnrollmentDetails>
</EnrollmentResults>