Skip to main content

Get all software statements for the given organisation

GET 
/organisations/:OrganisationId/softwarestatements

get all software statements

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

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.

Responses​

All software statements for the org

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • SoftwareStatementCertifications

    object[]

  • Array [

    • CertificationStartDate CertificationStartDate (string)

    Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

    JSONDatetime of certification start date

    CertificationExpirationDate CertificationExpirationDate (string)

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

    JSONDatetime of certification expiration date

    CertificationId SoftwareStatementCertificationId (string)

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

    Unique ID associated with the software statement certification

    SoftwareStatementId SoftwareStatementId (string)

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

    Unique Software Statement Id

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    ProfileVariant ProfileVariant (string)

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

    Certification variant

    ProfileType ProfileType (string)

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

    Certification type

    ProfileVersion number

    The version number of the certification

    CertificationURI uri

    Possible values: <= 500 characters, Value must match regular expression ^(https://).*

    Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

    CertificationStatus CertificationStatusEnum (string)

    Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

    Default value: Awaiting Certification

    The different types of certification status

  • ]

  • ]

Loading...