Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
The TaxBlaster model contains the REST interface for TaxBlaster, and its supporting datatypes.
*/
rapidModel TaxBlasterWithExamples
resourceAPI TaxBlasterInterface baseURI "http://taxblaster.com/api"
/** The Index Resource is the entry point to the TaxBlaster API.
To minimize coupling, consuming applications should start here,
and follow the links to related resources.
*/
objectResource IndexObject type Index
URI index
mediaTypes
application/json
method GET getIndex
response IndexObject statusCode 200
response statusCode 404
/** The list of TaxBlaster users. The results will vary in membership
and level of detail, depending on your access privileges.
*/
collectionResource PersonCollection type Person
URI /people
mediaTypes
application/json
method GET getPeople
request
response PersonCollection statusCode 200
example '''[
{
"taxpayerID": "user1",
"lastName": "Smith",
"firstName": "John",
"otherNames": [
"Jean Poupon"
]
},
{
"taxpayerID": "user2",
"lastName": "Williams",
"firstName": "Nancy"
},
{
"taxpayerID": "user3",
"lastName": "Davis",
"firstName": "Elizabeth"
},
{
"taxpayerID": "user4",
"lastName": "Johnson",
"firstName": "Robert"
}
]'''
response statusCode 404
/** The list of Tax Filings visible to the authorized user. */
collectionResource TaxFilingCollection type TaxFiling
URI taxFilings
mediaTypes
application/json
method GET getTaxFilings
request
response TaxFilingCollection statusCode 200
example '''[
{
"filingID": "taxFiling1",
"jurisdiction": "BURLINGAME",
"year": 2012,
"currency": "USD",
"grossIncome": 12345.67,
"taxLiability": 12.34
},
{
"filingID": "taxFiling2",
"jurisdiction": "CORCORAN",
"year": 2013,
"currency": "USD",
"grossIncome": 98765.43,
"taxLiability": 23.45
},
{
"filingID": "taxFiling3",
"jurisdiction": "CLAYTON",
"year": 2012,
"currency": "USD",
"grossIncome": 56789.12,
"taxLiability": 12.34
}
]'''
response statusCode 404
/** An individual Tax Filing record, accessed by its ID */
objectResource TaxFilingObject type TaxFiling
URI taxFilings/{filingID}
required templateParam filingID property filingID
referenceLink > taxpayer
targetResource PersonObject
targetProperties
taxpayerID
lastName
linkRelation about
mediaTypes
application/json
method GET getTaxFiling
request
response TaxFilingObject statusCode 200
example '''{
"filingID": "taxFiling1",
"jurisdiction": "",
"year": 2012,
"currency": "USD",
"grossIncome": 12345.67,
"taxLiability": 12.34
} '''
response statusCode 404
/** An individual user by ID. */
objectResource PersonObject type Person
URI people/{id}
required templateParam id property taxpayerID
mediaTypes
application/json
method GET getPerson
request
response PersonObject statusCode 200
example '''{
"taxpayerID": "user1",
"lastName": "Smith",
"firstName": "John",
"otherNames": [
"Jean Poupon"
]
}'''
method PUT putPerson
request PersonObject
example '''{
"lastName": "Lee",
"firstName": "Linda",
}'''
response statusCode 200
response statusCode 400
/** Supporting data types for the TaxBlaster API */
dataModel TaxBlasterDataModel
/** A tax filing record for a given user, in a given tax jurisdiction,
in a specified tax year.
*/
structure TaxFiling
/** A unique, system-assigned identifier for the tax filing. */
filingID : string
/** Reference to the person who owns this filing. */
taxpayer : reference Person
/** Country, province, state or local tax authority
where this is being filed.
*/
jurisdiction : string
/** Tax year */
year : gYear
/** Period within the year, if any */
period : int
/** Currency code */
currency : string
/** Total income reported on tax filing. */
grossIncome : decimal
/** Net tax liability */
taxLiability : decimal
/** A TaxBlaster user. */
structure Person
/** A unique, system-assigned identifier for the user. */
taxpayerID : string
/** Legal family name. */
lastName : string
/** Legal first name. */
firstName : string
/** Names previously used **/
otherNames : string*
/** Residential address for tax purposes. */
addresses : containing reference Address*
/** A physical address. */
structure Address
/** First address line, required. */
street1 : string
/** Second address line, optional */
street2 : string?
/** Standardized city name. */
city : string
/** State or Province */
stateOrProvince : string
/** Zipcode (US) or other postal code. */
postalCode : string
/** Standardized country code. */
country : string
/** The supporting data type for the Index resource. Not meaningful
as a business entity, but required to support a single point of
entry.
*/
structure Index
people : reference Person*
taxFilings : reference TaxFiling*
