Skip to main content
API docs by Redocly

Example Agency API (2.0.0)

Download OpenAPI specification:Download

Example Agency API team: exampleteam@api.govt.nz URL: https://agency.govt.nz Terms of Service

A sample API specification demonstrating OpenAPI capabilities - this is for example purposes only

get customer details

Retrieve a specific customer record

Returns details for a customer given a unique customer ID

Authorizations:
AuthorizationCode
path Parameters
customerId
required
string

Unique ID of customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "names": {
    },
  • "addresses": [
    ],
  • "_links": [
    ]
}

modify customer

Updates a customer’s details

Updates a customer’s details

Authorizations:
AuthorizationCode
path Parameters
customerId
required
string

Unique ID of customer

Request Body schema: application/json
required
object
Array of objects

An array of addresses. Unpopulated properties or items will be returned as null JSON objects.

Responses

Request samples

Content type
application/json
{
  • "names": {
    },
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "_links": [
    ]
}

delete customer

Deletes an existing customer resource

Deletes an existing customer resource

Authorizations:
AuthorizationCode
path Parameters
customerId
required
string

Unique ID of customer

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "_links": [
    ]
}

create customer

Creates a new customer. API will create a customer

Creates a new customer. API will create a customer resource and, if successful, return a hyperlink to the created resource

Authorizations:
AuthorizationCode
Request Body schema: application/json
required
object
Array of objects

An array of addresses. Unpopulated properties or items will be returned as null JSON objects.

Responses

Request samples

Content type
application/json
{
  • "names": {
    },
  • "addresses": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]