SuperStream

Returns the list of SuperStream Conversations

get/sites/{site-identifier}/superstream/conversations

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/superstream/conversations
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

categorystring required
statusstring
start-datestring date

The start date to search for transactions (yyyy-MM-dd).

end-datestring date

The valuation date with format (yyyy-MM-dd).

fund-guidstring

The GUID that identifies a fund.

list-identifierstring
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

The GUID or code of the fund list.

The json object representing the fund list definition.

Response

Success

ConversationIdstring
FundCodestring
FundNamestring
MemberNamestring
MemberGUIDstring guid
Status'ROLLIN-REQUEST-CREATED' | 'ROLLIN-REQUEST-ERROR' | 'ROLLIN-REQUESTED' | 'ROLLIN-REQUEST-DENIED' | 'ROLLIN-RECEIVED' | 'ROLLIN-PROCESSED' | 'ROLLIN-RESPONSE-CREATED' | 'ROLLIN-COMPLETED-ERROR' | 'ROLLIN-COMPLETED' | 'ROLLIN-REQUEST-MANUAL' | 'ROLLIN-REQUEST-ERROR-DISMISSED' | 'ROLLOUT-REQUEST-CREATED' | 'ROLLOUT-REQUEST-ERROR' | 'ROLLOUT-REQUESTED' | 'ROLLOUT-REQUEST-DENIAL-CREATED' | 'ROLLOUT-REQUEST-DENIED' | 'ROLLOUT-REQUEST-DENIAL-ERROR' | 'ROLLOUT-REQUEST-COMPLETED' | 'ROLLOUT-REQUEST-MANUAL' | 'ROLLOUT-REQUEST-REVIEW' | 'ROLLOUT-REQUEST-COMPLETED' | 'ROLLOUT-REQUEST-PROCESSED' | 'ROLLOUT-REQUEST-EPF-COMPLETED' | 'ROLLOUT-REQUEST-EPF-RECEIVED' | 'ROLLOUT-REQUEST-EPF-DISMISSED' | 'ROLLOUT-REQUEST-ERROR-DISMISSED' | 'RELEASE-AUTHORITY-RECEIVED' | 'RELEASE-AUTHORITY-COMPLETED' | 'RELEASE-AUTHORITY-ERROR-CREATED' | 'RELEASE-AUTHORITY-ERROR-SENT' | 'RELEASE-AUTHORITY-ERROR-MANUAL' | 'RELEASE-AUTHORITY-PAYMENT-CREATED' | 'RELEASE-AUTHORITY-PAYMENT-INCOMPLETE' | 'RELEASE-AUTHORITY-PAYMENT-SENT' | 'RELEASE-AUTHORITY-PAYMENT-ERROR' | 'RELEASE-AUTHORITY-PAYMENT-COMPLETED' | 'RELEASE-AUTHORITY-PAYMENT-MANUAL' | 'RELEASE-AUTHORITY-PAYMENT-MANUAL-DISMISSED' | 'MEMBER-VERIFICATION-RECEIVED' | 'MEMBER-VERIFICATION-SUCCESSFUL-RESPONSE-CREATED' | 'MEMBER-VERIFICATION-SUCCESSFUL-RESPONSE-SENT' | 'MEMBER-VERIFICATION-UNSUCCESSFUL-RESPONSE-CREATED' | 'MEMBER-VERIFICATION-UNSUCCESSFUL-RESPONSE-SENT' | 'MEMBER-VERIFICATION-ERROR' | 'MEMBER-VERIFICATION-ERROR-DISMISSED'
MessageDatestring date
MessageDirection'Received' | 'Sent'
MessageType'ContributionTransactionErrorResponse' | 'ContributionTransactionRequest' | 'ContributionTransactionResponse' | 'GovernmentContributionTransactionAmendmentOutcomeResponse' | 'GovernmentContributionTransactionErrorResponse' | 'GovernmentContributionTransactionAmendmentRequest' | 'GovernmentContributionTransactionRequest' | 'MemberRegistrationRequest' | 'MemberRegistrationResponse' | 'MbrRegAndContTrxnRequest' | 'MbrRegAndContTrxnResponse' | 'MemberVerificationRequest' | 'MemberVerificationResponse' | 'InitiateRolloverRequest' | 'InitiateRolloverErrorResponse' | 'RolloverTransactionRequest' | 'RolloverTransactionOutcomeResponse' | 'ElectronicPortabilityForm' | 'ReleaseAuthority' | 'ReleaseAuthorityErrorResponse' | 'ReleaseAuthorityStatement' | 'ReleaseAuthorityStatementOutcomeResponse'
Amountnumber
ContributionDatestring date
RolloverInstitutionstring
EmployerNamestring
ReleaseAuthorityType'FHSSS' | 'ECC' | 'ENCC' | 'ENCCT' | 'Div293' | 'DivDef'
PaymentReferencestring
Notesstring
UserCommentsstring
MessageGUIDstring guid
ActiveMemberboolean
HasLinkedResponseboolean
CreatedUserNamestring

Example response

[
  {
    "ConversationId": "Rollover.36985470606.00007614",
    "FundCode": "00001039",
    "MemberGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8",
    "EmployerName": "SuperConcepts Pty Ltd",
    "PaymentReference": "200106093430706036",
    "HasLinkedResponse": true,
    "CreatedUserName": "Mary Smith"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.