IPND API

IPND data on a DID can be set via a set of API calls to the Neural API. 

 

The process involves two separate steps:

  1. Creating the IPND record
  2. Assigning the record to the appropriate DID(s)

 

 

1. Creating the IPND Record

 

POST URL:

https://api.neural.net.au:15000/set/ipnd-add

 

POST Fields:

Field name Example Data Type Description

Header Information

     
user example text Your portal username
pass 3x4mpl3 text Your portal password
name Head Office text Display name for the IPND entry (for reference only)

IPND Fields

     
title Ms text Contact name
firstname Judy text Contact name
surname Smith text Contact name
company Example Pty. Ltd. text Company name
building_type Office enum (see below) Building or structure type
unit_number 11 integer Unit number (blank if N/A) 
unit_suffix text Unit number (blank if N/A) 
floor_type Mezzanine enum (see below)  Floor number (blank if N/A) 
floor_number 2  integer Floor number (blank if N/A)  
floor_suffix L text Floor number (blank if N/A)  
street_number 123  integer Street number (NUMBER ONLY, ie. 123A = 123) 
street_number_suffix text Street number suffix (ie. 123A = A)  (blank if N/A) 
street_name Pitt  text Street name
street_type STREET  enum (see below)  Street type 
street_suffix East  text  Street suffix (blank if N/A) 
city Sydney text City name
state NSW 2-3 character (state code) State code (eg. NSW, VIC, QLD, WA, SA, TAS, ACT) 
postcode 2000 integer Post code

 

building_type values:

'Warehouse','Villa','Unit','Stall','House','Site','Shop','Shed','Suite','Room','Office','Marine Berth','Factory','Flat','Apartment'

 

floor_type values:

'Upper Ground Floor','Lower Ground Floor','Ground Floor','Level','Mezzanine','Basement','Floor'

 

street_type values:

'ALLEY','APPROACH','ARCADE','AVENUE','BOULEVARD','BROW','BYPASS','CAUSEWAY','CIRCUIT','CIRCUS','CLOSE','COPSE','CORNER','COVE','COURT','CRESCENT','DRIVE','END','ESPLANANDE','FLAT','FREEWAY','FRONTAGE','GARDENS','GLADE','GLEN','GREEN','GROVE','HEIGHTS','HIGHWAY','LANE','LINK','LOOP','MALL','MEWS','PACKET','PARADE','PARK','PARKWAY','PLACE','PROMENADE','RESERVE','RIDGE','RISE','ROAD','ROW','SQUARE','STREET','STRIP','TARN','TERRACE','THOROUGHFARE','TRACK','TRUNKWAY','VIEW','VISTA','WALK','WAY','WALKWAY','YARD'

 

Return:

The return body will contain the IPND record ID.  You will need to save this value for the next step.

 

Error handling:

You will receive HTTP code 200 on success.  Errors will return their appropriate HTTP codes (4xx, 5xx, etc.).

 

 

 

 

2. Assigning the record to the appropriate DID(s)

 

Now that we have an IPND record ID, we can assign it to a DID

 

POST URL:

https://api.neural.net.au:15000/set/editipnd

 

POST Fields:

Field name Example Data Type Description
user example text Your portal username
pass 3x4mpl3 text Your portal password
ipndid 1234 integer IPND record ID from the previous call
did 0299999999 integer The DID you wish to set the IPND record on

 

Note that the DID will need to be the FNN, including the area code.



Return:

If a record is updated, the return body will contain the text "OK".

If there is no change, the body will contain the text "NOCHANGE".  This means either the DID was not found, or the value was already set.

 

Error handling:

You will receive HTTP code 200 on success.  Errors will return their appropriate HTTP codes (4xx, 5xx, etc.).

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk