Framework | Electronic Certificate

Service to manage entities of type 'ElectronicCertificate'.

Overview

api/{tenantKey}/{orgKey}/reporting/electronicCertificates

URL	api/{tenantKey}/{orgKey}/reporting/electronicCertificates
Methods Supported	GET, PUT

All Operations

This service includes the following operations:

GET:
PUT:

All Resources

This service uses the following resources:

ElectronicCertificateResource

All Enumerations

This service uses the following enumerations:

ElectronicCertificateStatus

GET Operations

GET ElectronicCertificates (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See ElectronicCertificateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/odata

GET /reporting/electronicCertificates/odata

GET ElectronicCertificate by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See ElectronicCertificateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{id}

GET /reporting/electronicCertificates/{id}

GET ElectronicCertificate by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

Response:

When successful, the response body contains the entity record. See ElectronicCertificateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}

GET /reporting/electronicCertificates/{company}

PUT Operations

PUT Set AuthorizerID ElectronicCertificate

Updates the value of attribute 'AuthorizerID' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/authorizerID

PUT /reporting/electronicCertificates/{company}/authorizerID

PUT Set AuthorizerName ElectronicCertificate

Updates the value of attribute 'AuthorizerName' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/authorizerName

PUT /reporting/electronicCertificates/{company}/authorizerName

PUT Set AvailableSignatures ElectronicCertificate

Updates the value of attribute 'AvailableSignatures' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/availableSignatures

PUT /reporting/electronicCertificates/{company}/availableSignatures

PUT Set Company ElectronicCertificate

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/company

PUT /reporting/electronicCertificates/{company}/company

PUT Set ElectronicCertificateStatus ElectronicCertificate

Updates the value of attribute 'ElectronicCertificateStatus' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(enum ElectronicCertificateStatus) The request body should contain the new value for the attribute. See ElectronicCertificateStatus.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/electronicCertificateStatus

PUT /reporting/electronicCertificates/{company}/electronicCertificateStatus

PUT Set ExpiresOn ElectronicCertificate

Updates the value of attribute 'ExpiresOn' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/expiresOn

PUT /reporting/electronicCertificates/{company}/expiresOn

PUT Set IncludedSignatures ElectronicCertificate

Updates the value of attribute 'IncludedSignatures' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/includedSignatures

PUT /reporting/electronicCertificates/{company}/includedSignatures

PUT Set IsActive ElectronicCertificate

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/isActive

PUT /reporting/electronicCertificates/{company}/isActive

PUT Set Secret ElectronicCertificate

Updates the value of attribute 'Secret' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/secret

PUT /reporting/electronicCertificates/{company}/secret

PUT Set SkipCallActivateOwner ElectronicCertificate

Updates the value of attribute 'SkipCallActivateOwner' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/skipCallActivateOwner

PUT /reporting/electronicCertificates/{company}/skipCallActivateOwner

PUT Set Titular ElectronicCertificate

Updates the value of attribute 'Titular' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/titular

PUT /reporting/electronicCertificates/{company}/titular

PUT Set UsedSignatures ElectronicCertificate

Updates the value of attribute 'UsedSignatures' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/usedSignatures

PUT /reporting/electronicCertificates/{company}/usedSignatures

PUT Set ValidFrom ElectronicCertificate

Updates the value of attribute 'ValidFrom' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/validFrom

PUT /reporting/electronicCertificates/{company}/validFrom

PUT Set ValidUntil ElectronicCertificate

Updates the value of attribute 'ValidUntil' in the specified entity record.

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/reporting/electronicCertificates/{company}/validUntil

PUT /reporting/electronicCertificates/{company}/validUntil

Resources

ElectronicCertificateResource

The following elements are required:

company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
electronicCertificateStatus	(enum ElectronicCertificateStatus) Electronic Certificate Status. See ElectronicCertificateStatus.
skipCallActivateOwner	(bool) Skip Call Activate Owner.

The following elements are optional:

usedSignatures	(string) Used Signatures.
availableSignatures	(string) Available Signatures.
authorizerID	(string) Authorizer ID.
titular	(string) Titular.
includedSignatures	(string) Included Signatures.
validFrom	(string) Valid From.
validUntil	(string) Valid Until.
authorizerName	(string) Authorizer Name.
expiresOn	(string) Expires On.
secret	(string) Secret.

Enumerations

ElectronicCertificateStatus

1	Inactive
2	Active