GET FileIdentities

Returns a list of File Identity Summary records.

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
Page	Specifies the page number of the result set to return.	integer	None.
PageSize	Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified.	integer	None.

Body Parameters

None.

Response Information

Resource Description

FileIdentitySummaryResponse

Name	Description	Type	Additional information
FileIdentities	A list of file identity summaries.	Collection of FileIdentitySummary	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "FileIdentities": [
    {
      "Id": 1,
      "Name": "Test File",
      "Country": "Australia",
      "Zone": "Australia",
      "CurrencyCode": "AUD",
      "SubscriptionName": "Test Subscription 1",
      "FileSettings": {
        "SaleAmountsIncludeTax": false,
        "PurchaseAmountsIncludeTax": false,
        "SaleTradingTerms": {
          "TradingTermsType": 1,
          "TradingTermsInterval": 3,
          "TradingTermsIntervalType": 1
        },
        "PurchaseTradingTerms": {
          "TradingTermsType": 1,
          "TradingTermsInterval": 2,
          "TradingTermsIntervalType": 1
        },
        "_links": []
      },
      "IsTaxRegistered": false,
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/FileIdentity?wsaccesskey=869af5a2144523079a8csd8739467894&fileid=1",
          "method": "GET",
          "title": null
        }
      ]
    },
    {
      "Id": 2,
      "Name": "Test File",
      "Country": "New Zealand",
      "Zone": "New Zealand",
      "CurrencyCode": "NZD",
      "SubscriptionName": "Test Subscription 2",
      "FileSettings": {
        "SaleAmountsIncludeTax": false,
        "PurchaseAmountsIncludeTax": false,
        "SaleTradingTerms": {
          "TradingTermsType": 1,
          "TradingTermsInterval": 2,
          "TradingTermsIntervalType": 1
        },
        "PurchaseTradingTerms": {
          "TradingTermsType": 2,
          "TradingTermsInterval": 5,
          "TradingTermsIntervalType": 1
        },
        "_links": []
      },
      "IsTaxRegistered": false,
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/FileIdentity?wsaccesskey=869af5a2144523079a8csd8739467894&fileid=2",
          "method": "GET",
          "title": null
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/FileIdentities",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/FileIdentities?Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:

<FileIdentitySummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/FileIdentities</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/FileIdentities?Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <FileIdentities>
    <FileIdentitySummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/FileIdentity?wsaccesskey=869af5a2144523079a8csd8739467894&amp;fileid=1</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>1</Id>
      <Name>Test File</Name>
      <Country>Australia</Country>
      <Zone>Australia</Zone>
      <CurrencyCode>AUD</CurrencyCode>
      <SubscriptionName>Test Subscription 1</SubscriptionName>
      <FileSettings>
        <_links />
        <SaleAmountsIncludeTax>false</SaleAmountsIncludeTax>
        <PurchaseAmountsIncludeTax>false</PurchaseAmountsIncludeTax>
        <SaleTradingTerms>
          <TradingTermsType>1</TradingTermsType>
          <TradingTermsInterval>3</TradingTermsInterval>
          <TradingTermsIntervalType>1</TradingTermsIntervalType>
        </SaleTradingTerms>
        <PurchaseTradingTerms>
          <TradingTermsType>1</TradingTermsType>
          <TradingTermsInterval>2</TradingTermsInterval>
          <TradingTermsIntervalType>1</TradingTermsIntervalType>
        </PurchaseTradingTerms>
      </FileSettings>
      <IsTaxRegistered>false</IsTaxRegistered>
    </FileIdentitySummary>
    <FileIdentitySummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/FileIdentity?wsaccesskey=869af5a2144523079a8csd8739467894&amp;fileid=2</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>2</Id>
      <Name>Test File</Name>
      <Country>New Zealand</Country>
      <Zone>New Zealand</Zone>
      <CurrencyCode>NZD</CurrencyCode>
      <SubscriptionName>Test Subscription 2</SubscriptionName>
      <FileSettings>
        <_links />
        <SaleAmountsIncludeTax>false</SaleAmountsIncludeTax>
        <PurchaseAmountsIncludeTax>false</PurchaseAmountsIncludeTax>
        <SaleTradingTerms>
          <TradingTermsType>1</TradingTermsType>
          <TradingTermsInterval>2</TradingTermsInterval>
          <TradingTermsIntervalType>1</TradingTermsIntervalType>
        </SaleTradingTerms>
        <PurchaseTradingTerms>
          <TradingTermsType>2</TradingTermsType>
          <TradingTermsInterval>5</TradingTermsInterval>
          <TradingTermsIntervalType>1</TradingTermsIntervalType>
        </PurchaseTradingTerms>
      </FileSettings>
      <IsTaxRegistered>false</IsTaxRegistered>
    </FileIdentitySummary>
  </FileIdentities>
</FileIdentitySummaryResponse>