Skip to main content

Set certification type variant

POST 
/references/certificationtypes/:TypeID/variants

Set certification type variant

Request​

Path Parameters

    TypeID TypeIDrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The UUID used to denote the certification type in question

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Body

Request object to set a certification type

    VariantName VariantName (string)required

    Possible values: Value must match regular expression ^[^<>]*$

    Variant Name of the certification type

    Description Description (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Description of the certification type

    CertificationDurationDays CertificationDurationDays (integer)required

    Possible values: <= 36500

    The number of days a certification is valid for up to a maximum of 100 years

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Certification Type Variant

Response Headers

  • x-fapi-interaction-id

    string

Schema

    VariantID VariantID (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Variant ID of the certification type

    VariantName VariantName (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Variant Name of the certification type

    TypeID TypeID (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Type ID of the certification

    Description Description (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Description of the certification type

    CertificationDurationDays CertificationDurationDays (integer)

    Possible values: <= 36500

    The number of days a certification is valid for up to a maximum of 100 years

    CreatedAt date-time
    CreatedBy CreatedBy (string)

    Possible values: Value must match regular expression ^[^<>]*$

    User who created the certification type

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...