MR13C

Putting vehicle into TraderNet.

Notes and Prerequisites

• Make sure you tell us when you test MR13C. It requires manual setup before you do testing.
• All the requests use GET parameters
• in addition to XML format (default), we also support JSON formation which you can get using f=json parameter

API URL

Production: https://www.carjam.co.nz/api/mr13c/

Test: https://test.carjam.co.nz/api/mr13c/

Supported Actions

• mr13c_status — check the status of MR13C connection.
• mr13c_identify_vehicle — used to look-up vehicles to verify
• mr13c_advise_new_trader — putting a vehicle into Trader Net
• mr13c_daily_transaction_details — getting all the transaction for a date

Common Parameters

• action — one of the above actions
• key — your API Key
• nzta_trader_number — NZTA Customer/Trader Number

mr13c_status

Check the status of the MR13C connection. The approval process touches 3 organisations and the process is unfortunately manual.

Example response:

<message>
    <mr13c_status>
        <nzta_trader_number>123456-789</nzta_trader_number>
        <mr13_nzta_trader_number>234567-890</mr13_nzta_trader_number>
        <mr13_location_id>CJ123</mr13_location_id>
    </mr13c_status>
</message>

mr13c_identify_vehicle

Make sure you are about to put the right vehicle into Trader Net.

Input parameters:

• plate — plate of a vehicle

Example response:

<message>
    <mr13c_identify_vehicle>
        <trader_number>270458-955</trader_number>
        <plate>BGQ573</plate>
        <year_of_manufacture>1990</year_of_manufacture>
        <make>TOYOTA</make>
        <model>HILUX</model>
        <submodel>SURF SSR LIMITED</submodel>
        <main_colour>GREEN</main_colour>
    </mr13c_identify_vehicle>
</message>

mr13c_advise_new_trader

Transfer a vehicle identified by plate into Trader Net of a Trader identified by nzta_trader_number.

Input parameters:

• plate — plate of a vehicle

Example response:

<message>
    <mr13c_advise_new_trader>
        <trader_number>270458-955</trader_number>
        <plate>R3218</plate>
        <year_of_manufacture>1993</year_of_manufacture>
        <make>HOMEBUILT</make>
        <model>RR FBC F3</model>
        <submodel/>
        <main_colour>WHITE</main_colour>
    </mr13c_advise_new_trader>
</message>

mr13c_daily_transaction_details

List transactions for a date for nzta_trader_number.

Input parameters:

• date — date to get transactions for. If numeric it is UNIX timestamp. If a string it is anything accepted by strtotime(). If empty of invalid date 'today' is assumed.

Example response:

<message>
    <mr13c_daily_transaction_details>
        <transaction __array="true">
            <trader_number>270458-955</trader_number>
            <plate>CBC193</plate>
            <year_of_manufacture>2004</year_of_manufacture>
            <make>VOLKSWAGEN</make>
            <model>GOLF</model>
            <submodel>1.6 FSI TIP</submodel>
            <main_colour>SILVER</main_colour>
            <when>1402380600</when>
        </transaction>
        <transaction>
            <trader_number>270458-955</trader_number>
            <plate>1BARB</plate>
            <year_of_manufacture>2000</year_of_manufacture>
            <make>TOYOTA</make>
            <model>COROLLA</model>
            <submodel>1.6P XL HATCHBACK 5M</submodel>
            <main_colour>WHITE</main_colour>
            <when>1402381140</when>
        </transaction>
        <transaction>
            <trader_number>270458-955</trader_number>
            <plate>BGQ573</plate>
            <year_of_manufacture>1990</year_of_manufacture>
            <make>TOYOTA</make>
            <model>HILUX</model>
            <submodel>SURF SSR LIMITED</submodel>
            <main_colour>GREEN</main_colour>
            <when>1402381140</when>
        </transaction>
        <transaction>
            <trader_number>270458-955</trader_number>
            <plate>R3218</plate>
            <year_of_manufacture>1993</year_of_manufacture>
            <make>HOMEBUILT</make>
            <model>RR FBC F3</model>
            <submodel/>
            <main_colour>WHITE</main_colour>
            <when>1402388160</when>
        </transaction>
    </mr13c_daily_transaction_details>
</message>

mr13c_reverse

Reverse a transaction for a date, plate and nzta_trader_number.

Input parameters:

• date — date to get transactions for. If numeric it is UNIX timestamp. If a string it is anything accepted by strtotime(). No empty values are accepted.

• plate — plate of a vehicle. Cannot be empty.

• reason — reason for a reversal. Cannot be empty. Possible values are listed below.

• reason_description — if reason is "badother" this cannot be empty.

reason values:

• 'baddeal' — Deal fell through, and we did not trade the vehicle

• 'badrego' — Wrong registration number was entered

• 'badtransfer' — New owner already lodged 13c

• 'badother' — Any other reason but requires reason_description to be specified.

Example response:

<message>
    <mr13c_status>
        <trader_number>177996-513</trader_number>
        <plate>85ULY</plate>
        <year_of_manufacture>2001</year_of_manufacture>
        <make>JOHN DEERE</make>
        <model>6910</model>
        <submodel/>
        <main_colour>GREEN</main_colour>
        <when>1423004940</when>
        <reversal_emailed>1423731595</reversal_emailed>
        <reversed>0</reversed>
        <reversal_reason>badother</reversal_reason>
        <reversal_reason_description>whatever!</reversal_reason_description>
        <id>6</id>
    </mr13c_status>
</message>