REST Auth API: CertificateGeneration
CertificateGeneration resources represent a request to start an async task for generating certificates of a specific registration.
Resource URI
/api/2012-02-01/auth/resources/registrations/{RegistrationID}/certificategenerationrequests/
Related resource links
Link (title) | Description |
---|---|
AsyncTask | Reference to an AsyncTask that is going to create certificate files of the registration. |
HTTP POST
Returns an AsyncTask with a link that is going to create certificate files of the registration.
Optional parameters
Parameter | Description |
---|---|
DocumentTemplateID |
A document template with a specific id that is going to be used to apply to the certificates.
If the event the registration belongs to doesn't have a default certificate template setting, this parameter is necessary; otherwise, an error will be responded. The following example shows the DocumentTemplateID format.
|
Example 1
POST /api/2012-02-01/auth/resources/registrations/529/certificategenerationrequests/?DocumentTemplateID=13eb6ec0-887e-4263-9261-98852554b192
The response see Example 2.
Example 2
POST /api/2012-02-01/auth/resources/registrations/529/certificategenerationrequests/
<CertificateGenerationRequest> <AsyncTasks> <AsyncTaskID>f4cf4ada-4810-455c-89ee-2c6f5cf71d21</AsyncTaskID> </AsyncTasks> <Link rel="related" type="application/xml" title="AsyncTask" href="https://demo.arlo.co/api/2012-02-01/auth/resources/asynctasks/f4cf4ada-4810-455c-89ee-2c6f5cf71d21/"/> </CertificateGenerationRequest>
HTTP GET
Not supported.
HTTP PUT
Not supported.
HTTP DELETE
Not supported.