CreateReport

Creates a HTML and PDF astrology report.

All fields starting with P1- need to be duplicated and changed to P2- to add a second person for relationship reports.

Simple HTML form to test method available here: CreateReport Test Form

Request Parameters
ReportCodeRequiredDefines which report is to be created.  The ReportCode is part of the service address.

/v2/reports/CreateReport/ReportCode/

APIKeyRequiredA valid API Key for your user account. Provided in setup email
P1FirstNameRequiredFirst name for person
P1LastNameOptionalLast name for person
P1SexRequiredSingle letter code :
M for male,  F for female
P1DOBRequiredYYYY-MM-DD format.  Add zeros to single digit months or days.
Example:   1970-06-27, 2011-12-09
P1TimeUnknownOptional1 for time unknown
0 or leave blank for time known (and add time to P1Time)
P1TimeRequired24 hour hh:mm format, add zeros to single digit hours.
Example: 13:26, 09:07
Time is not required if P1TimeUnknown is set to 1
P1LocationCodeRequiredUnique location of birth code.  You must use CheckLocation before calling this method to collect this code
P1CurrentLocationCodeOptionalUnique current location city code.  You must use CheckLocation before calling this method to collect this code.
Only required for some forecast reports.
ForecastDateOptionalStart date for forecast reports.
YYYY-MM-DD format.  Add zeros to single digit months or days.
Example:   2018-12-09
OrderIDOptionalYour own order ID, add if you want to track your orders against our billing system.
TestModeOptionalEnable test mode by setting field to 1. Test mode allows creation of reports without being billed for the report.
OutputFormatOptionalDefault response format is set to XML, select JSON by adding outputformat=JSON to any request.

 

Responses
ResponseStatus
CodeCode representing errors see result codes to determine the error.
MessageDescription of the error
ResponseData
HTMLREPORTHTML Astrology Report (wrapped in CDATA)
AdditionalDataExtra astrological data included in some reports.
HTMLREPORTHTML Astrology Report
PDFUrlURL to PDF Report

Positive result code indicates success, negative shows a failure.

Success Codes

1       OK – Created report

Input Errors – Person 1

-11      Error – Missing first name
-12      Error – Sex not provided or invalid
-13      Error – Missing date of birth
-14      Error – Invalid date of birth
-15      Error – Missing time of birth (set P1TimeUnknown to 1 if time is unknown)
-16      Error – Invalid time of birth
-17      Error – Missing location code
-18      Error – Invalid location code
-19      Error – Invalid current location code

Input Errors – Person 2

-21      Error – Person 2 – Missing first name
-22      Error – Person 2 – Sex not provided or invalid
-23      Error – Person 2 – Missing date of birth
-24      Error – Person 2 – Invalid date of birth
-25      Error – Person 2 – Missing time of birth (set P2TimeUnknown to 1 if time is unknown)
-26      Error – Person 2 – Invalid time of birth
-27      Error – Person 2 – Missing location code
-28      Error – Person 2 – Invalid location code
-29      Error – Person 2 – Invalid current location code

Action Errors

-31    Error – Invalid or Expired ReportID
-32    Error – Invalid or ForecastDate

API Key Errors

-41      Error – Missing API Key
-42     Error – Invalid or expired API Key

System Errors

-91      Error – System error – retry later.

Example Request

Creating a report for the following birth details:
First Name : John
Last Name : Smith
Sex : Male
Date of Birth : 15th June 1970
Time of Birth :  6:20 PM
Location : Orlando, Florida

In this example PRO-ST-CHART is the ReportCode

/v2/reports/CreateREPORT/PRO-ST-CHART/?&APIKEY=YOURAPIKEY&P1FirstName=John&P1LastName=Smith&P1Sex=M&P1DOB=1970-06-15&P1Time=18:20&P1LocationCode=7842193

Example Response

<CreateReportResponse>
<ResponseData>
<AdditionalData i:nil = "true"/>
<HTMLReport>
<Content>
<![CDATA[
<html><head><title>Soul Profile Sample</title><link href=”https://az792155.vo.msecnd.net/html/astro-remote.css” rel=”stylesheet”/></head><body>test …..</body></html>
]]>
</Content></HTMLReport>
</ResponseData>
<ResponseStatus>
<Code>1</Code>
<Message>OK - Created report</Message>
</ResponseStatus>
</CreateReportResponse>