Skip to main content

Get all TnC data of the given organisation

GET 
/organisations/:OrganisationId/tnchistory

returns all tnc data for a specific organisation

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

Query Parameters

    page integer

    The page number to return of the result set

    size integer

    The size of the pages to return

    sort string

    The field name to sort

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​

Org TnCs history

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • InitiatedBy string

    Email of the user who initiated the External signing for this participant

    Role string

    Role of the user who initiated the External signing for this participant

    TermsAndConditionsDetail

    object

    TnC details Parent

    TermsAndConditionsItem

    object

    ExternalSigningService

    object

    ExternalSigningServiceName ExternalSigningServiceName (string)

    Possible values: [DocuSign]

    The Name of the External Signing Service

    ExternalSigningServiceSignerTemplateConfig

    object

    Signer1TemplateId string

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

    Template ID for 1 signer

    Signer1Version integer

    Version of the TnC document

    Signer2TemplateId string

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

    Template ID for 2 signers

    Signer2Version integer

    Version of the TnC document

    Signer3TemplateId string

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

    Template ID for 3 signers

    Signer3Version integer

    Version of the TnC document

    Signer4TemplateId string

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

    Template ID for 4 signers

    Signer4Version integer

    Version of the TnC document

    Signer5TemplateId string

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

    Template ID for 5 signers

    Signer5Version integer

    Version of the TnC document

    Signer6TemplateId string

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

    Template ID for 6 signers

    Signer6Version integer

    Version of the TnC document

    ExternalSigningServiceSubject string

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

    The Subject of the External Signing Service

    ExternalSigningServiceEmailSubject string

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

    The Subject of the Email for External Signing Service

    Version integer

    Version of the TnC

    TnCId integer

    Unique identifier for the Terms and Conditions Item

    Name stringrequired

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

    The Name of the TnC

    Type stringrequired

    Possible values: [Participant, Directory]

    Role for which this TnC applies

    Content stringrequired

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

    The MarkDown of the TnC

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    InititatedDate string

    Possible values: <= 255 characters

    Terms and Conditions initiated date

    ExternalSigningServiceEnvelopeId ExternalSigningServiceEnvelopeId (string)

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

    The envelope id of the ess signing request

    ExternalSigningServiceEnvelopeStatus ExternalSigningServiceEnvelopeStatus

    Possible values: [completed, created, declined, deleted, delivered, processing, sent, signed, template, voided, expired, reissued]

    ExternalSigningServiceEnvelopePasscode string

    Access code for the specifier to fill in the signer details. This will be populated only once, when signing is initiated

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...