Coruson API

<back to all web services

ImportReportsStatus

Coruson Reports

Requires Authentication
The following routes are available for this service:
GET/api/reports/import/status/{importId}Get the status of imported reportsObtain a list of the reports that have been imported and the report number assigned to them
ImportReportsStatus Parameters:
NameParameterData TypeRequiredDescription
ImportIdpathGuidYesThe Id of the imported reports job that was included in the response of the import reports request
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
ImportReportsStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ImportedReportsformDictionary<Guid, string>No
TotalReportsImportedformintNo
TotalReportsformintNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /xml/reply/ImportReportsStatus HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<ImportReportsStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <ImportId>00000000-0000-0000-0000-000000000000</ImportId>
</ImportReportsStatus>
                    
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ImportReportsStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <ImportedReports xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidstring>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfguidstring>
  </ImportedReports>
  <TotalReportsImported>0</TotalReportsImported>
  <TotalReports>0</TotalReports>
</ImportReportsStatusResponse>