Go to full article


Overview

This function will update the availability information for a specific GNAF address.

Update Address Availability

 To update the GNAF address:

  1. Create an updateAddressAvailability request
  2. Specify the address ID
  3. Specify the service type id
  4. Specify the service_availability description id
  5. Specify the GNAF carrier location profile ID.

If successful, the word, true, will be returned.

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

Services/updateAddressAvailability



Business Rules

This function can only be used by the provider directly responsible for managing the carrier infrastructure. In a situation where there is a wholesale service provider and a retail service provider in Cumulus, this will typically be the Wholesaler. If you are unsure, please contact the Emersion support team.

GNAF carrier location profile

If this data is not supplied:

  • The system will attempt to find it using the other information in the import sheet and update the existing record.
  • If no record can be found, the system will send back an error advising the user to provide one.

If it is provided:

  • the system will update the record.

If it is provided, but cannot not found

  • the system will create a new one.




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:updateAddressAvailabilityRequest>
         <urn:gnaf_address_id>?</urn:gnaf_address_id>
         <urn:service_type_id>?</urn:service_type_id>
         <urn:service_availability_desc_id>?</urn:service_availability_desc_id>
         <urn:gnaf_carrier_locn_profile_id>?</urn:gnaf_carrier_locn_profile_id>
      </urn:updateAddressAvailabilityRequest>
   </soapenv:Body>
</soapenv:Envelope>




Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information.

NameDescriptionRequired?Field Type

Character

limit

Values 
address_id
The unique identifier for a GNAF address.YesInteger

A valid GNAF address ID.

service_type_id
The unique identifier for a service typeYesInteger
A valid service type ID that is mapped to your service provider account.
service_availability_desc_id
The unique identifier of the service availability description you want the address to adopt.YesInteger
A valid service availability description ID
gnaf_carrier_locn_profile_id
The unique identifier of the GNAF carrier location profile.No (if updating an existing record)Integer

A valid GNAF carrier location profile ID. One of two values will apply:

  • If this is to remain unchanged, enter the current ID.
  • If the value is being updated, enter the new ID.



Error Handling

Error MessageDescription
You do not own the provided G-NAF address idYou are not responsible for managing the carrier infrastructure.
Provided service availability desc id does not match the provided service type idYou have provided either an invalid service type id or service availability desc id. Please use Service Availability Reference Data report to identify the correct combination of values.
Provided service type does not support storage of a service addressThe Service Type provided does not allow for the service address to be stored. You will need to contact the Emersion support team to resolve this.




Reference Data

The following Cumulus reports can be used to obtain the reference data needed to use this function. Reports can be accessed in Cumulus under Reports > List. Click the sub tab that matches the report group in the table below.

DataReport IDReport NameReport Group
Service Type IDs863Service Type ListReference
Service Availability Description IDs1201Service Availability Reference DataReference
GNAF carrier location profile IDs1201Service Availability Reference DataReference

Alternative Locations

Address IDs can be obtained by using the Get Address From Address Library API call, or directly from a customer's service subscription record. Go to Customer > Service Subscriptions > Service Address tab and see the GNAF address ID.