Creates a shorter XML astrology report, with less birth data requirements.
All fields starting with P1- need to be duplicated and changed to P2- to add a second person for relationship reports.
| Request Parameters | ||
|---|---|---|
| ReportCode | Required | Defines which report is to be created. The ReportCode is part of the service address. /v2/reports/CreateShortXML/ReportCode/ |
| APIKey | Required | A valid API Key for your user account. Provided in setup email |
| P1FirstName | Required | First name for person |
| P1LastName | Optional | Last name for person |
| P1Sex | Required | Single letter code : M for male, F for female |
| P1DOB | Required | YYYY-MM-DD format. Add zeros to single digit months or days. Example: 1970-06-27, 2011-12-09 |
| OrderID | Optional | Your own order ID, add if you want to track your orders against our billing system. |
| TestMode | Optional | Enable test mode by setting field to 1. Test mode allows creation of reports without being billed for the report. |
| OutputFormat | Optional | Default response format is set to XML, select JSON by adding outputformat=JSON to any request. |
| OutputChoices | Optional | Comma separated list of user selections, used when user is prompted with a list of questions. |
| Responses | ||
|---|---|---|
| ResponseStatus | ||
| Code | Code representing errors see result codes to determine the error. | |
| Message | Description of the error | |
| ResponseData | ||
| XML | XML astrology report. | |
| AdditionalData | Extra astrological data included in some reports. | |
CreateShortXML Result codes
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
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
Action Errors
-31 Error – Invalid or Expired ReportID
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 short XML report for the following birth details:
First Name : John
Last Name : Smith
Sex : Male
Date of Birth : 15th June 1970
In this example PRO-ST-CHART is the ReportCode
/v2/reports/CreateShortXML/PRO-ST-CHART/?&APIKEY=YOURAPIKEY&P1FirstName=John&P1LastName=Smith&P1Sex=M&P1DOB=1970-06-15
Example Response
<CreateShortXMLResponse>
<ResponseData>
<AdditionalData i:nil = "true"/>
<XML><Report><Settings Name="Free Chart Wheel"/><ReportIntro><Heading>Free Chart Wheel</Heading><Body>Welcome to your Cosmic Wheel report - a detailed introduction to your astrological profile. This report explains the essence of the Sun and Moon's position as well as some of the other planets and important points in your Birth Chart. Although this report, based on the time, if given, and place of your birth, is as accurate as is possible, it is inevitable that not everything will apply to you, personally. The planets in their courses reveal your potential, as well as the crossroads and signposts you will encounter on your personal voyage through life. But your destiny is not predetermined, and it is up to you to make what you will of that potential, and to decide which direction to take. Hopefully, this planet in sign interpretation will help you to make the right decisions, at the right time, and in the right frame of mind. Beneath your birth chart wheel at the beginning of this report, the positions of the planets in your birth chart are set out by zodiac sign and degree. You will find a key to the zodiac symbols in your interpretation at the end of the report.</Body></Report></XML>
</ResponseData>
<ResponseStatus>
<Code>1</Code>
<Message>OK - Created report</Message>
</ResponseStatus>
</CreateShortXMLResponse>