Developers

    API Reference

    The Sargon API is organised around REST.

    Our API has resource-oriented URLs, and uses HTTP response codes to indicate API errors.

    We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code).

    JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

    To make the API as explorable as possible, we have test mode and production mode API keys. Requests made with test mode credentials are for prototyping only and do not hit our production systems.

    Authentication

    Authenticate your account by including your API Keys in your API requests.

    You can manage your API keys in the Developer section of your account. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

    You can hit the endpoints directly or use our API client libraries to easily get started

    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

    Security

    The API has been designed from the ground up with security in mind including access control, API security best practices including industry and widely accepted standards for authentication.

    The security implementation within the API is part of a larger Sargon security environment and is enhanced by additional security measures at the network infrastructure and back-office system layers.

    For production applications integrating with Sargon, an additional integration security assessment and monitoring as an additional layer of security. Please read our Security Guidelines.

    Pagination

    Some top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list members and transactions.

    These list API methods share a common structure, taking at least these three parameters: p (pagination page number), i (page size), and o (and the starting offset).

    Errors

    Sargon uses conventional HTTP response codes to indicate the success or failure of an API request.

    In general:

    • Codes in the 2xx range indicate success.

    • Codes in the 4xx range indicate an error that failed given the information provided (e.g. required and/or insufficient parameters)

    • Codes in the 5xx range indicate an error with Sargon's servers (these are rare).

    Errors that could be handled programmatically include an error code that briefly explains the error reported.

    Versioning

    We generally avoid make backwards-incompatible changes to the API. By default, all API calls will be made to the latest version of our API.

    In special circumstances, you can set the API version on a specific request by using the Sargon-Version HTTP header or a corresponding API client library parameter.

    Members

    Member Resources represent the the Members of a fund and are the cornerstone of the API. All other resources are related to a Member.

    The API allows member management (for funds), along with creation & management (for member self-service).

    List Members

    Returns a paginated collection of accessible members.

    The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.

    The Members Collection resource is subject to various limits and controls, these include:

    • Request Rate Limiting
    • Result Limiting
    • Minimum Query Length

    The date search feature searches on the member joinedDate attribute.

    Query Parameters

    q

    string

    Collection Quick Search String.

    "Quick Search" provides an easy to utilise multiple-attribute search mechanism. The fields searched by quick search vary depending

    upon the resource type.

    A quick search on Members MAY query the givenName, alternativeName, familyName and email attributes. A quick search on Funds MAY query the fund name, ABN, USI and product names.

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    memberNumber

    string

    Member Number or Range of Member Numbers to search

    A Range can be specified separated by a comma in the form of memberNumber=min,max

    If only one member number is specified that member will be searched for. If min is empty the API will search for all members up to and including max. If max is empty the API will search for all members from and including min and up.

    Examples:

    • 30120020 - A single member number
    • 30120020,30120040 - A range of member numbers
    • ,30120040 - All member numbers up to and including 30120040
    • 30120040, - All member numbers from 30120040 and up, inclusive.

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    Responses

    200 - Member Collection

    display

    string

    A human readable description of this resource, subresource or link.

    familyName

    string

    The Member's family name. In western countries this is usually the surname or lastname.

    flagInsured

    boolean

    The Member has active Insurance

    flagIsContributor

    boolean

    The Member is a Contributor

    flagIsFamilyLawMember

    boolean

    The Member is a Family Law Member

    flagIsPensionAccount

    boolean

    The Member has a Pension Account

    givenName

    string

    The Member's given name. In western countries this is usually the first name.

    joinedDate

    string

    Date the Member joined

    memberNumber

    string

    The Member's Membership Number.

    created

    string

    Resource creation date/time in ISO 8601 format.

    full

    string

    Link to the "full" representation of the resource.

    id

    string

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    memberStatus

    string

    Membership Status. The specific membership status and meanings utilised may vary on a fund by fund basis.

    suburb

    string

    Member's Residential Suburb

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    429 - Rate Limited

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members

    Example response: 200 - Member Collection

    [ { "display": "Display Text", "familyName": "string", "flagInsured": true, "flagIsContributor": true, "flagIsFamilyLawMember": true, "flagIsPensionAccount": true, "givenName": "string", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "created": "2017-01-31T21:00Z", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "memberStatus": "Active", "suburb": "string", "updated": "2017-01-31T21:00Z" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Example response: 429 - Rate Limited

    { "message": "string" }

    Create New Member

    Creates a new Member.

    No authentication (other than API Key) is required to create a new Member. On creation a valid access token with member scope will be returned in the response to be used for further api requests on behalf of this member.

    New Members requests are created as temporary entities at the API level (not propogated to the backend) until the member has provided sufficient details and been identity verified.

    Once a member has been identity verified, some attributes will no longer be updatable. These attributes are shown with an unverified indicator.

    Request body

    familyName

    string

    required

    The Member's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    required

    The Member's given name. In western countries this is usually the first name.

    addressResidential

    object

    required

    Residential Address

    birthDate

    string

    required

    The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

    email

    string

    required

    Email Address

    phoneMobile

    string

    required

    Mobile Phone Number

    taxId

    string

    required

    The Member's Tax Identifier. For Australia, this is the Tax File Number. This value may be obsificated by the API. In this case an asterisk will replace any masked characters.

    Responses

    201 - Member Created Resource

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    token

    object

    Member access token

    400 - Bad Request

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members

    Example request:

    { "familyName": "string", "givenName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "joe@test.com", "phoneMobile": "555 555-1234", "taxId": "430 *** ***" }

    Example response: 201 - Member Created Resource

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "token": { "access_token": "string", "expires_in": 0, "scope": "string", "token_type": "string" } }

    Example response: 400 - Bad Request

    { "message": "string" }

    Get Member

    Production only

    Return the full representation of the requested member by member UUID.

    When accessed using member credentials the result is limited to the currently authenticated member.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Member Resource

    display

    string

    A human readable description of this resource, subresource or link.

    familyName

    string

    The Member's family name. In western countries this is usually the surname or lastname.

    flagInsured

    boolean

    The Member has active Insurance

    flagIsContributor

    boolean

    The Member is a Contributor

    flagIsFamilyLawMember

    boolean

    The Member is a Family Law Member

    flagIsPensionAccount

    boolean

    The Member has a Pension Account

    givenName

    string

    The Member's given name. In western countries this is usually the first name.

    joinedDate

    string

    Date the Member joined

    memberNumber

    string

    The Member's Membership Number.

    addressResidential

    object

    Residential Address

    balances

    array

    Member Balances split by currency. Usually only one element will be returned containing the default currency for this member.

    birthDate

    string

    The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

    currency

    string

    The default currency for this member

    email

    string

    Email Address

    idVerificationStatus

    string

    Identity verification status. Indicates if the member identity has been successfully verified.

    phoneMobile

    string

    Mobile Phone Number

    taxIdStatus

    string

    tfnStatus indiciates the members' current Tax ID status.

    lastFailedLogin

    string

    Last Failed Login time for Member

    lastSuccessfulLogin

    string

    Last Login Time for Member

    loginFailures

    integer

    Number of Login Failures for this member since last successful login

    memberStatus

    string

    Membership Status. The specific membership status and meanings utilised may vary on a fund by fund basis.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}

    Example response: 200 - Member Resource

    { "display": "Display Text", "familyName": "string", "flagInsured": true, "flagIsContributor": true, "flagIsFamilyLawMember": true, "flagIsPensionAccount": true, "givenName": "string", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "balances": [ { "preserved": { "nonPreserved": 0, "preserved": 0, "unrestricted": 0, "property1": 0, "property2": 0 }, "tax": { "exempt": 0, "taxed": 0, "untaxed": 0, "property1": 0, "property2": 0 }, "updated": "2018-10-11T22:51:30Z", "valuation": 0, "currency": "string" } ], "birthDate": "1967-**-**", "currency": "string", "email": "joe@test.com", "idVerificationStatus": "Validated", "phoneMobile": "555 555-1234", "taxIdStatus": "Supplied", "lastFailedLogin": "2014-12-15T12:31:00Z", "lastSuccessfulLogin": "2014-12-15T12:31:00Z", "loginFailures": 0, "memberStatus": "Active" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Update Member

    Update or perform an operation on a Member resource.

    Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a unverified indicator.

    However they may be updated in certain circumstances including:

    • Self-serve with valid member credientials prior to the aquisition of a identity verification.
    • When accessed using fundOperator credentials and appropriate permissions.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Request body

    familyName

    string

    The Member's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    The Member's given name. In western countries this is usually the first name.

    addressResidential

    object

    Residential Address

    birthDate

    string

    The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

    email

    string

    Email Address

    phoneMobile

    string

    Mobile Phone Number

    memberStatus

    string

    Membership Status. The specific membership status and meanings utilised may vary on a fund by fund basis.

    password

    string

    User Password. If supplied in a request body, the user password will be changed. When changing a password the API MAY request an OTP challenge/response.

    taxId

    string

    The Member's Tax Identifier. For Australia, this is the Tax File Number. This value may be obsificated by the API. In this case an asterisk will replace any masked characters.

    Responses

    200 - Member Resource

    display

    string

    A human readable description of this resource, subresource or link.

    familyName

    string

    The Member's family name. In western countries this is usually the surname or lastname.

    flagInsured

    boolean

    The Member has active Insurance

    flagIsContributor

    boolean

    The Member is a Contributor

    flagIsFamilyLawMember

    boolean

    The Member is a Family Law Member

    flagIsPensionAccount

    boolean

    The Member has a Pension Account

    givenName

    string

    The Member's given name. In western countries this is usually the first name.

    joinedDate

    string

    Date the Member joined

    memberNumber

    string

    The Member's Membership Number.

    addressResidential

    object

    Residential Address

    balances

    array

    Member Balances split by currency. Usually only one element will be returned containing the default currency for this member.

    birthDate

    string

    The Member's Date of Birth. This value may be obscuficated by the API. In this case an asterisk will replace any masked characters.

    currency

    string

    The default currency for this member

    email

    string

    Email Address

    idVerificationStatus

    string

    Identity verification status. Indicates if the member identity has been successfully verified.

    phoneMobile

    string

    Mobile Phone Number

    taxIdStatus

    string

    tfnStatus indiciates the members' current Tax ID status.

    lastFailedLogin

    string

    Last Failed Login time for Member

    lastSuccessfulLogin

    string

    Last Login Time for Member

    loginFailures

    integer

    Number of Login Failures for this member since last successful login

    memberStatus

    string

    Membership Status. The specific membership status and meanings utilised may vary on a fund by fund basis.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}

    Example request:

    { "familyName": "string", "givenName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "1967-**-**", "email": "joe@test.com", "phoneMobile": "555 555-1234", "memberStatus": "Active", "password": "pa$$word", "taxId": "430 *** ***" }

    Example response: 200 - Member Resource

    { "display": "Display Text", "familyName": "string", "flagInsured": true, "flagIsContributor": true, "flagIsFamilyLawMember": true, "flagIsPensionAccount": true, "givenName": "string", "joinedDate": "2014-12-15T12:31:00Z", "memberNumber": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "balances": [ { "preserved": { "nonPreserved": 0, "preserved": 0, "unrestricted": 0, "property1": 0, "property2": 0 }, "tax": { "exempt": 0, "taxed": 0, "untaxed": 0, "property1": 0, "property2": 0 }, "updated": "2018-10-11T22:51:30Z", "valuation": 0, "currency": "string" } ], "birthDate": "1967-**-**", "currency": "string", "email": "joe@test.com", "idVerificationStatus": "Validated", "phoneMobile": "555 555-1234", "taxIdStatus": "Supplied", "lastFailedLogin": "2014-12-15T12:31:00Z", "lastSuccessfulLogin": "2014-12-15T12:31:00Z", "loginFailures": 0, "memberStatus": "Active" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Account Activity

    Production only

    List account activity for a Member resource.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Activity Collection Response

    attachments

    array

    Array of Attachments attached to this event

    description

    string

    required

    Description of this event

    effectiveDate

    string

    Timestamp of when this event takes effect.

    eventCode

    string

    Internal event type of this event.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    initiatedBy

    string

    required

    Indicator of how the event was initiated (by whom).

    status

    string

    required

    Status of this event

    timeComplete

    string

    Timestamp of when this event was completed.

    timeStart

    string

    Timestamp of when this event was initiated.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/activity

    Example response: 200 - Activity Collection Response

    [ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "description": "string", "effectiveDate": "2018-10-11T22:51:30Z", "eventCode": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "initiatedBy": "Member", "status": "Pending", "timeComplete": "2018-10-11T22:51:30Z", "timeStart": "2018-10-11T22:51:30Z" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Member Contacts

    Production only

    List contacts for a Member resource.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    contactType

    string

    Filter by Contact Type

    Responses

    200 - Contact Collection Response

    address

    object

    Primary Address

    contactType

    string

    Contact Type

    created

    string

    Resource creation date/time in ISO 8601 format.

    display

    string

    A human readable description of this resource, subresource or link.

    email

    string

    Contact Email Address

    phone

    string

    Contact Telephone Number

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/contacts

    Example response: 200 - Contact Collection Response

    [ { "address": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "contactType": "Advisor", "created": "2017-01-31T21:00Z", "display": "Display Text", "email": "user@example.com", "phone": "string", "updated": "2017-01-31T21:00Z" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Beneficiaries

    The Beneficiary Resource represents the nominated beneficiaries associated with a member.

    Beneficiary Resources exist independently to the nominated beneficiary allocation. Beneficiaries must be created before they can be allocated to.

    A usual workflow for a new member, may be processed as:

    • Add Beneficiary "Jane"

    • Add Beneficiary "Bob"

    • Update Beneficiary Allocation (50% to Jane, 50% to Bob)

    List Beneficiaries

    Production only

    List beneficiaries for a member resource.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Beneficiary Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    beneficiaryType

    string

    percentage

    number

    Percentage of total benefit to allocate this beneficiary.

    400 - Bad Request

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/beneficiaries

    Example response: 200 - Beneficiary Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0 } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Add New Beneficiary

    Production only

    Add a new beneficiary for a member resource.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Request body

    additionalName

    string

    The Person's additional name. This can be used for a members' middle names.

    addressResidential

    object

    Residential Address

    birthDate

    string

    Beneficiary Date of Birth

    familyName

    string

    required

    The Person's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    required

    The Person's given name. In western countries this is usually the first name.

    relationship

    string

    Beneficiary Relationship

    Responses

    201 - Created

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/beneficiaries

    Example request:

    { "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2018-10-11", "familyName": "string", "givenName": "string", "relationship": "Child" }

    Example response: 201 - Created

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Historic Beneficiary Allocations

    Production only

    Return cash beneficiary allocations by effectiveDate. Note: The response may contain future allocations requested, but not yet effective.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    sort

    string

    Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

    Responses

    200 - Beneficiary Allocation Historic Collection Response

    allocations

    array

    effectiveDate

    string

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/beneficiaries/allocationhistory

    Example response: 200 - Beneficiary Allocation Historic Collection Response

    [ { "allocations": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ], "effectiveDate": "2018-10-11" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Beneficiary Allocations

    Production only

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Beneficiary Allocation Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    percent

    number

    required

    Percentage to allocate

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/beneficiaries/allocations

    Example response: 200 - Beneficiary Allocation Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Update Beneficiary Allocation

    Production only

    Update the allocation of benefit across beneficiaries. Beneficiaries must be created with a call to the Create Beneficiary end point before an allocation can be made.

    A representation of all allocations must be included in the request. The sum of all percentages specified MUST equal 100.

    The response from Get Beneficiary Allocations may be updated with new percentages and supplied as the payload to this request. id and percent are required in each of the items within the payload array. All other meta attributes (full, display etc) will be ignored, if supplied.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    effectiveDate

    string

    Update the allocations effective from the supplied date.

    Request body

    id

    string

    required

    The Universally Unique Resource Identifier (UUID) of the target resource.

    percent

    number

    required

    Percentage to allocate

    Responses

    200 - Beneficiary Allocation Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    percent

    number

    required

    Percentage to allocate

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    PUT
    https://api.sargon.com.au/members/{member}/beneficiaries/allocations

    Example request:

    [ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]

    Example response: 200 - Beneficiary Allocation Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Get Beneficiary Detail

    Production only

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    beneficiary

    string

    Unique UUID of the Beneficiary.

    Responses

    200 - Beneficiary Resource Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    beneficiaryType

    string

    percentage

    number

    Percentage of total benefit to allocate this beneficiary.

    additionalName

    string

    The Person's additional name. This can be used for a members' middle names.

    addressResidential

    object

    Residential Address

    birthDate

    string

    Beneficiary Date of Birth

    familyName

    string

    required

    The Person's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    required

    The Person's given name. In western countries this is usually the first name.

    relationship

    string

    Beneficiary Relationship

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/beneficiaries/{beneficiary}

    Example response: 200 - Beneficiary Resource Response

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0, "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2018-10-11", "familyName": "string", "givenName": "string", "relationship": "Child" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Update Beneficiary Detail

    Production only

    Update (Non-binding) Beneficiary details. HTTP Status 400 (Bad Request) will be returned by the API if the Update call is made on a Binding Beneficiary

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    beneficiary

    string

    Unique UUID of the Beneficiary.

    Request body

    additionalName

    string

    The Person's additional name. This can be used for a members' middle names.

    addressResidential

    object

    Residential Address

    birthDate

    string

    Beneficiary Date of Birth

    familyName

    string

    required

    The Person's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    required

    The Person's given name. In western countries this is usually the first name.

    relationship

    string

    Beneficiary Relationship

    Responses

    200 - Beneficiary Resource Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    beneficiaryType

    string

    percentage

    number

    Percentage of total benefit to allocate this beneficiary.

    additionalName

    string

    The Person's additional name. This can be used for a members' middle names.

    addressResidential

    object

    Residential Address

    birthDate

    string

    Beneficiary Date of Birth

    familyName

    string

    required

    The Person's family name. In western countries this is usually the surname or lastname.

    givenName

    string

    required

    The Person's given name. In western countries this is usually the first name.

    relationship

    string

    Beneficiary Relationship

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/beneficiaries/{beneficiary}

    Example request:

    { "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2018-10-11", "familyName": "string", "givenName": "string", "relationship": "Child" }

    Example response: 200 - Beneficiary Resource Response

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "beneficiaryType": "Non-Binding", "percentage": 0, "additionalName": "string", "addressResidential": { "countryCode": "AU", "line1": "139 Strange Way", "line2": "Unit 7", "postcode": 2008, "state": "NSW", "suburb": "Chippendale" }, "birthDate": "2018-10-11", "familyName": "string", "givenName": "string", "relationship": "Child" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Delete Beneficiary

    Production only

    Delete the specified Beneficiary If the beneficiary has an allocation, it must be set to zero using Update Beneficiary Allocations before deleting the beneficiary.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    beneficiary

    string

    Unique UUID of the Beneficiary.

    Responses

    204 - Empty Body

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    DELETE
    https://api.sargon.com.au/members/{member}/beneficiaries/{beneficiary}

    Example response: 204 - Empty Body

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Investments

    Investment Resources represent individual investments made on behalf of the Member.

    Switch Between Investments

    Production only

    Switch Between Investment

    Path parameters

    investment

    string

    Unique UUID of the Investment

    destination

    string

    Unique UUID of the Destination Investment

    Query Parameters

    effectiveDate

    string

    Update the allocations effective from the supplied date.

    Request body

    amount

    number

    Dollar Amount to transfer from source investment to destination investment.

    percent

    number

    Percentage of the source investment to transfer to the destination investment.

    Responses

    201 - Created

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/investments/{investment}/switch/{destination}

    Example request:

    { "amount": 0, "percent": 0 }

    Example response: 201 - Created

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Get Future Cash Allocations

    Production only

    Get most recent future cash allocations

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Contribution Allocation Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    percent

    number

    required

    Percentage to allocate

    400 - Bad Request

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/futurecash

    Example response: 200 - Contribution Allocation Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Update Future Cash Allocations

    Production only

    Update the Future Cash Allocations.

    This Resource accepts a JSON array of ContributionAllocation Resources which each contain an pointer to an Investment Resource and percentage attribute. A representation of all allocations must be included in the request. The sum of all percentages specified MUST equal 100.

    The response from Get Future Cash Allocations may be updated with new percentages and supplied as the payload to this request. id and percent are required in each of the items within the payload array. All other meta attributes (full, display etc) will be ignored, if supplied.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    effectiveDate

    string

    Update the allocations effective from the supplied date.

    Request body

    id

    string

    required

    The Universally Unique Resource Identifier (UUID) of the target resource.

    percent

    number

    required

    Percentage to allocate

    Responses

    200 - Contribution Allocation Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    percent

    number

    required

    Percentage to allocate

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    PUT
    https://api.sargon.com.au/members/{member}/futurecash

    Example request:

    [ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]

    Example response: 200 - Contribution Allocation Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Historic Cash Allocations

    Production only

    Return cash allocation settings by effectiveDate.

    Note: The response may contain future allocations requested, but yet effective.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    sort

    string

    Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

    Responses

    200 - Future Cash Allocation Historic Collection Response

    allocations

    array

    effectiveDate

    string

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/futurecashhistory

    Example response: 200 - Future Cash Allocation Historic Collection Response

    [ { "allocations": [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "percent": 0 } ], "effectiveDate": "2018-10-11" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Member's Investments

    Production only

    List of Investments for the requested Member

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    all

    boolean

    Show all available Investments, not just those the member has Holdings in.

    Responses

    200 - Investment Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    canBuy

    boolean

    This investment can be purchased.

    canSell

    boolean

    This investment can be sold.

    units

    number

    The number of units that this investment represents.

    valuation

    object

    Valuation of this investment. The integrator MUST also include the information from updated when referring to the valuation. This attribute is not included if the member does not having holdings in this investment.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/investments

    Example response: 200 - Investment Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "canBuy": true, "canSell": true, "units": 0, "valuation": { "amount": 100.1, "currency": "AUD", "description": "string" } } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Retrieve Historical Performance Data

    Production only

    Returns a representation of Performance Data for the specified date range, frequency and investments.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    type

    string

    Type of performance data to return. Valid values are:

    • unitprice - return historical unit prices for the specified investments.
    • value - return historical estimated value of a member's holdings within the specified investments.
    • fum - return all information for funds under management.

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    sort

    string

    Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

    frequency

    string

    Reporting Frequency of the resulting data

    investment

    array

    UUID of the Investment to query. This parameter accepts a comma separated list of investment UUIDs.

    Responses

    200 - FUM Graph Data

    display

    string

    A human readable description of this resource, subresource or link.

    series

    array

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/investments/performance

    Example response: 200 - FUM Graph Data

    { "display": "Display Text", "series": [ { "display": "Display Text", "points": [ { "index": 1, "label": "Unit Price as of 31st Jan 2016", "value": 3.2 } ], "units": "AUD" } ] }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Get Member's Investment Details

    Production only

    Get Investment Details

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    investment

    string

    Unique UUID of the Investment

    Responses

    200 - Investment Resource Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    canBuy

    boolean

    This investment can be purchased.

    canSell

    boolean

    This investment can be sold.

    units

    number

    The number of units that this investment represents.

    valuation

    object

    Valuation of this investment. The integrator MUST also include the information from updated when referring to the valuation. This attribute is not included if the member does not having holdings in this investment.

    buyPrice

    object

    The latest buy price known sell price for this investment.

    investmentDescription

    string

    Additional human readable description of the investmentType

    investmentType

    string

    Fund-wide identifier for the type of Investment held in this account.

    sellPrice

    object

    The latest sell price known sell price for this investment.

    400 - Bad Request

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/investments/{investment}

    Example response: 200 - Investment Resource Response

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "canBuy": true, "canSell": true, "units": 0, "valuation": { "amount": 100.1, "currency": "AUD", "description": "string" }, "buyPrice": { "amount": 100.1, "currency": "AUD", "description": "string" }, "investmentDescription": "string", "investmentType": "string", "sellPrice": { "amount": 100.1, "currency": "AUD", "description": "string" } }

    Example response: 400 - Bad Request

    { "message": "string" }

    Request Investment Rebalance

    Production only

    Request a rebalance of investments based on the supplied Investment Allocations. This Resource accepts a JSON array of ContributionAllocation Resources which each contain an pointer to an Investment Resource and percentage attribute.

    The entire representation of all allocations must be included in the request and the percentage attributes across the array MUST add to 100%. Any Investment Resources not included in the representation will be set to 0%.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    effectiveDate

    string

    Update the allocations effective from the supplied date.

    Request body

    id

    string

    required

    The Universally Unique Resource Identifier (UUID) of the target resource.

    percent

    number

    required

    Percentage to allocate

    Responses

    204 - Empty Body

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    PUT
    https://api.sargon.com.au/members/{member}/rebalance

    Example request:

    [ { "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "percent": 0 } ]

    Example response: 204 - Empty Body

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Insurance

    Insurance Resources represent the Insurance Products associated with the Member.

    For the purpose of this section the following terms are defined:

    • Insurance Product - A product that may be added to a members profile

    • Insurance Policy - An insurance product attached to a members profile

    Insurance Products may require additional questions to be answered by the member. Making an OPTIONS call to the product endpoint will return a JSON Schema response containing full details of the additional attributes/questions to be supplied when applying for the product.

    List Member's Insurance Policies

    Production only

    Collection of Insurance Policies for this Member

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Insurance Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    coverAmount

    object

    Amount of Cover

    coverName

    string

    coverType

    string

    effectiveFrom

    string

    effectiveTo

    string

    premiumAmount

    object

    Estimated Monthly Premium

    premiumPeriod

    string

    status

    string

    required

    Status of this Insurance Product

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/insurance

    Example response: 200 - Insurance Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "coverAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2018-10-11", "effectiveTo": "2018-10-11", "premiumAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "premiumPeriod": "monthly", "status": "QUOTE" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Apply for Insurance Policy

    Production only

    Create an application for a new Insurance Policy for this member, using the specified Insurance Product. Additional dynamic properties are supported in the request payload depending on the product being created. Refer to Get Product Attributes for retrieving the JSON Schema for a specific Product.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Request body

    product

    string

    UUID of the Insurance Product definition for the policy that is being created.

    Responses

    201 - Created

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/insurance

    Example request:

    { "product": "559fa04e-6753-4e50-9fe7-563c213d13ea" }

    Example response: 201 - Created

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    List Available Insurance Products

    Production only

    Returns a collection of insurance products that can be attached to or activated for this member.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Responses

    200 - Insurance Products Collection Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    commencementDate

    string

    currentStatus

    string

    description

    string

    productType

    string

    400 - Bad Request

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/insurance/products

    Example response: 200 - Insurance Products Collection Response

    [ { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "commencementDate": "2018-10-11", "currentStatus": "AVAILABLE", "description": "string", "productType": "TPD" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Get Product Attributes

    Production only

    Retrieve a JSON Schema definition for the fields required to create a policy from this product. A consumer SHOULD ensure that the payload used when creating a new policy from this product validates against this schema. "JSON Schema" is a well supported standard for annotating and validating JSON data. See http://json-schema.org/

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    product

    string

    Unique UUID of the Insurance Product.

    Responses

    200 - JSON Schema Definition

    N/A

    400 - Bad Request

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/insurance/products/{product}

    Example response: 200 - JSON Schema Definition

    {}

    Example response: 400 - Bad Request

    { "message": "string" }

    Get Insurance Policy Details

    Production only

    Retrieve the full details of the specified Insurance Policy

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    policy

    string

    Unique UUID of the Insurance Policy

    Responses

    200 - Insurance Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    coverAmount

    object

    Amount of Cover

    coverName

    string

    coverType

    string

    effectiveFrom

    string

    effectiveTo

    string

    premiumAmount

    object

    Estimated Monthly Premium

    premiumPeriod

    string

    status

    string

    required

    Status of this Insurance Product

    benefitPeriod

    string

    waitPeriod

    string

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/insurance/{policy}

    Example response: 200 - Insurance Response

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "coverAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2018-10-11", "effectiveTo": "2018-10-11", "premiumAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "premiumPeriod": "monthly", "status": "QUOTE", "benefitPeriod": "string", "waitPeriod": "string" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Update Insurance Policy Details

    Production only

    Update details of the specified Insurance Policy

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    policy

    string

    Unique UUID of the Insurance Policy

    Request body

    Responses

    200 - Insurance Response

    created

    string

    required

    Resource creation date/time in ISO 8601 format.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    full

    string

    required

    Link to the "full" representation of the resource.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    updated

    string

    required

    Resource last updated date/time in ISO 8601 format.

    coverAmount

    object

    Amount of Cover

    coverName

    string

    coverType

    string

    effectiveFrom

    string

    effectiveTo

    string

    premiumAmount

    object

    Estimated Monthly Premium

    premiumPeriod

    string

    status

    string

    required

    Status of this Insurance Product

    benefitPeriod

    string

    waitPeriod

    string

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    PUT
    https://api.sargon.com.au/members/{member}/insurance/{policy}

    Example request:

    {}

    Example response: 200 - Insurance Response

    { "created": "2017-01-31T21:00Z", "display": "Display Text", "full": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "updated": "2017-01-31T21:00Z", "coverAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "coverName": "string", "coverType": "string", "effectiveFrom": "2018-10-11", "effectiveTo": "2018-10-11", "premiumAmount": { "amount": 100.1, "currency": "AUD", "description": "string" }, "premiumPeriod": "monthly", "status": "QUOTE", "benefitPeriod": "string", "waitPeriod": "string" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Request Insurance Policy Cancellation

    Production only

    Request cancellation an existing (active) insurance policy.

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    policy

    string

    Unique UUID of the Insurance Policy

    Responses

    204 - Empty Body

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    DELETE
    https://api.sargon.com.au/members/{member}/insurance/{policy}

    Example response: 204 - Empty Body

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Transactions

    Transaction Resources represent individual transactions for a member or investment.

    All Transaction details are returned as a read-only collection and the API does not provide any operations at the Resource level.

    List Transactions

    Production only

    List Transactions. Defaults to transactions belonging to the currently authenticated member when accessed with member credentials. If authenticated using fundOperator credentials, a member UUID may be specified as a query parameter to limit results to the specified member.

    Query Parameters

    member

    string

    Show only Transactions belonging to the specified Member.

    This option is only available to fund and integration authorisation levels.

    Member authentication will default to the currently authenticated member.

    type

    string

    Show only Transactions of the specified type.

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    amount

    string

    Return results for the specified amount (or amount range). Amount can be provided with up to two decimal places (e.g. 3200.32).

    A Range can be specified separated by a comma in the form of amount=lower,higher

    If only one amount is specified the API will return results matching only that amount. If lower is empty the API will search for all amounts below and including the higher amount. If higher is empty the API will search for all amounts above and including the lower amount.

    Examples:

    • 3012.12 - Match an exact value of 3012.12 only
    • 100, - Match any amount equal to or above 100
    • ,100 - Match any amount equal to or below 100
    • 100,200 - Match an value between 100 and 200, inclusive

    q

    string

    Collection Quick Search String.

    "Quick Search" provides an easy to utilise multiple-attribute search mechanism. The fields searched by quick search vary depending

    upon the resource type.

    A quick search on Members MAY query the givenName, alternativeName, familyName and email attributes. A quick search on Funds MAY query the fund name, ABN, USI and product names.

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    sort

    string

    Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

    Responses

    200 - Transaction Collection

    amountIn

    object

    The amount credited to this investment as a result of this transaction represented as a floating point number with 2 digit precision.

    amountOut

    object

    The amount debited from this investment as a result of this transaction represented as a floating point number with 2 digit precision.

    balance

    object

    required

    The balance as a result of this transaction represented as a floating point number with 2 digit precision.

    coa

    string

    Internal COA Code this transaction is linked to.

    display

    string

    required

    A human readable description of this resource, subresource or link.

    effectiveDate

    string

    The effective date of this transaction in ISO 8601 format.

    id

    string

    required

    The Universally Unqiue Resource Identifier (UUID) for this Resource.

    member

    string

    URI of the associated Member resource

    paidDate

    string

    The date this transaction was settled in ISO 8601 format.

    transactionType

    string

    Transaction Type. List of Transaction types will vary based on specific Fund configuration.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/transactions

    Example response: 200 - Transaction Collection

    [ { "amountIn": 9121.34, "amountOut": 8234.21, "balance": { "amount": 100.1, "currency": "AUD", "description": "string" }, "coa": "string", "display": "Display Text", "effectiveDate": "2015-01-19T17:50:00.000Z", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48", "member": "/members/2109987f-a750-4ddf-93b3-6d4e46a17e48/...", "paidDate": "2015-01-19T17:50:00.000Z", "transactionType": "Contribution" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Communications

    Resources related to member communication and audit logs.

    List Communications

    Production only

    List Comunications

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Query Parameters

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    sort

    string

    Sort by date in ascending/oldest first (asc) or descending/newest first (desc) order.

    communicationType

    string

    Filter by Communication Type

    Responses

    200 - Communication Collection Response

    attachments

    array

    Array of Attachments attached to this communication

    communicationType

    string

    conversation

    array

    Array of Conversations attached to this communication

    created

    string

    Resource creation date/time in ISO 8601 format.

    hasAttachements

    boolean

    hasUnread

    boolean

    isVisibleToMember

    boolean

    requireFollowUp

    boolean

    Requested a followup.

    subject

    string

    Subject of this Communications

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/communications

    Example response: 200 - Communication Collection Response

    [ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Create New Communication

    Production only

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    Request body

    requireFollowUp

    boolean

    Requested a followup.

    subject

    string

    Subject of this Communications

    html_body

    string

    Body of this communication in plain text.

    text_body

    string

    Body of this communication in plain text.

    Responses

    200 - Communication Resource Response

    attachments

    array

    Array of Attachments attached to this communication

    communicationType

    string

    conversation

    array

    Array of Conversations attached to this communication

    created

    string

    Resource creation date/time in ISO 8601 format.

    hasAttachements

    boolean

    hasUnread

    boolean

    isVisibleToMember

    boolean

    requireFollowUp

    boolean

    Requested a followup.

    subject

    string

    Subject of this Communications

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/communications

    Example request:

    { "requireFollowUp": true, "subject": "string", "html_body": "string", "text_body": "string" }

    Example response: 200 - Communication Resource Response

    { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Get Communication Details

    Production only

    Get Communication Detail

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    communication

    string

    Unique UUID of the Communication.

    Responses

    200 - Communication Collection Response

    attachments

    array

    Array of Attachments attached to this communication

    communicationType

    string

    conversation

    array

    Array of Conversations attached to this communication

    created

    string

    Resource creation date/time in ISO 8601 format.

    hasAttachements

    boolean

    hasUnread

    boolean

    isVisibleToMember

    boolean

    requireFollowUp

    boolean

    Requested a followup.

    subject

    string

    Subject of this Communications

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/members/{member}/communications/{communication}

    Example response: 200 - Communication Collection Response

    [ { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" } ]

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Update Communication

    Production only

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    communication

    string

    Unique UUID of the Communication.

    Request body

    html_body

    string

    Body of this communication in plain text.

    text_body

    string

    Body of this communication in plain text.

    Responses

    200 - Communication Resource Response

    attachments

    array

    Array of Attachments attached to this communication

    communicationType

    string

    conversation

    array

    Array of Conversations attached to this communication

    created

    string

    Resource creation date/time in ISO 8601 format.

    hasAttachements

    boolean

    hasUnread

    boolean

    isVisibleToMember

    boolean

    requireFollowUp

    boolean

    Requested a followup.

    subject

    string

    Subject of this Communications

    updated

    string

    Resource last updated date/time in ISO 8601 format.

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/communications/{communication}

    Example request:

    { "html_body": "string", "text_body": "string" }

    Example response: 200 - Communication Resource Response

    { "attachments": [ { "created": "2017-01-31T21:00Z", "fileName": "string", "fileSize": 0, "fileType": "string", "fileUri": "string", "id": "2109987f-a750-4ddf-93b3-6d4e46a17e48" } ], "communicationType": "MESSAGES", "conversation": [ { "created": "2017-01-31T21:00Z", "createdByIp": "string", "fromMember": false, "html_body": "string", "isVisibleToMember": true, "read": "2017-01-31T21:00Z", "text_body": "string" } ], "created": "2017-01-31T21:00Z", "hasAttachements": false, "hasUnread": false, "isVisibleToMember": true, "requireFollowUp": true, "subject": "string", "updated": "2017-01-31T21:00Z" }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Upload Communications Attachment

    Production only

    Path parameters

    member

    string

    Unqiue UUID of the Member.

    A value of "me" can be provided instead of a literal UUID. "me" will be expanded to represent the currently authenticated member, if any.

    communication

    string

    Unique UUID of the Communication.

    Responses

    201 - Created

    400 - Bad Request

    message

    string

    required

    Error Message

    404 - Forbidden/Not Found

    message

    string

    required

    Error Message

    POST
    https://api.sargon.com.au/members/{member}/communications/{communication}/upload

    Example response: 201 - Created

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 404 - Forbidden/Not Found

    { "message": "string" }

    Reports

    Get Balance

    Returns the total assets of a fund at a point in time. The total is returned as an amount, with a specified currency.

    A date range may be specified to return two or more totals.

    Query Parameters

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    Responses

    200 - Balance Report Collection

    balances

    array

    400 - Bad Request

    message

    string

    required

    Error Message

    429 - Rate Limited

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/reports/balance

    Example response: 200 - Balance Report Collection

    { "balances": [ { "balance": { "amount": 100.1, "currency": "AUD", "description": "string" }, "effectiveDate": "2017-01-31T21:00Z" } ] }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 429 - Rate Limited

    { "message": "string" }

    Get Members

    Returns the member count for a point in time or a time range. The total is returned as an active and inactive user count.

    A date range may be specified to return two or more totals.

    Query Parameters

    date

    string

    Return results for the specified date (or date range). Date must be provided in ISO 8601 date format (YYYY-MM-DD) with optional times.

    A Range can be specified separated by a comma in the form of date=start_date,end_date

    If only one date is specified the API will return results for only the specified date. If start date is empty the API will search for all dates up to and including the end date. If end date is empty the API will search for all dates including and after the start date. If the specified dates do not include a time the API will default the start dates time to 00:00 and the end dates time to 23:59:59

    Examples:

    • 2016-01-01 - Single day date range covering the date 2016-01-01 only
    • 2016-01-01, - All dates from 2016-01-01, including 2016-01-01
    • ,2016-01-01 - All dates up to and including 2016-01-01
    • 2016-01-01,2016-02-28 - All dates from 2016-01-01 to 2016-02-28 inclusive
    • ,today - All dates up to and including todays date
    • today, - All dates from and including todays date

    p

    integer

    Pagination Page Number

    i

    integer

    Pagination Page Size (number of entries per page)

    o

    integer

    Pagination Starting Offset

    Responses

    200 - Member Report Collection

    members

    array

    400 - Bad Request

    message

    string

    required

    Error Message

    429 - Rate Limited

    message

    string

    required

    Error Message

    GET
    https://api.sargon.com.au/reports/members

    Example response: 200 - Member Report Collection

    { "members": [ { "effectiveDate": "2017-01-31T21:00Z", "members": { "active": 31000, "inactive": 2502 } } ] }

    Example response: 400 - Bad Request

    { "message": "string" }

    Example response: 429 - Rate Limited

    { "message": "string" }

    WebHooks

    Pre-defined callbacks to fund-based integration and notification systems.

    Copyright © Sargon 2018  

    Terms|Privacy