Coruson API

<back to all web services

ImportReports

Coruson Reports

Requires Authentication
The following routes are available for this service:
POST/api/reports/importImport Reports to CorusonProvide an XML file that fits the schema to create reports
ImportReports Parameters:
NameParameterData TypeRequiredDescription
FilenamebodystringYesThe filename of the xml to import reports
FileBytesbodybyte[]YesThe byte array of the xml to import reports
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
ImportReportsResponse Parameters:
NameParameterData TypeRequiredDescription
ImportIdformGuidNo
DuplicateReportsformList<Guid>No
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/ImportReports HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<ImportReports xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Filename>String</Filename>
  <FileBytes>AA==</FileBytes>
</ImportReports>
                    
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ImportReportsResponse 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>
  <ImportId>00000000-0000-0000-0000-000000000000</ImportId>
  <DuplicateReports xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </DuplicateReports>
</ImportReportsResponse>