Page tree
Skip to end of metadata
Go to start of metadata

The providers endpoint provides a way of retrieving basic details about the providers that have registered with NZOR for harvesting.

Methods

/providers

Returns a paged list of all the providers that have registered with NZOR.

Parameters

pageThe pagination offset for the list of results.
pagesizeThe number of results to display during pagination.

/providers/{providerId}

Returns a specific provider resource by Id.

Parameters

provideridThe unique identifier for the provider.
 
 

Model

This element gives a summary of the details for a provider.

ProviderIdUnique identifier for the provider.
CodeUnique code for the provider.
NameFull name of the provider.

 

 

 Example Response (Click to expand)
<?xml version="1.0" encoding="utf-8"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Providers>
    <Provider>
      <ProviderId>d0b0b9fb-bda0-43a6-9bb2-07b6f3db2c26</ProviderId>
      <Code>NZOR_Test</Code>
      <Name>NZOR Test</Name>
    </Provider>
  </Providers>
</Response>

 


  • No labels