A newer version of this documentation is available.

View Latest

General

NiP API (also called back-end) is a web service API that provides the requestor with information through HTTP. The web service supports the following protocols:

  • SOAP 1.1/1.2

  • REST

NiP API (Net iD Portal Application Programming Interface)

NiP API is a web service that contains all the structure and interfaces connecting to the services on server side.
NiP API contains two main web services:

Application

The purpose of the application service is to provide the NiP GUI with a server application interface.

External

The purpose of the external service is to provide third party vendors with a server application interface against Net iD Portal.

The interfaces of the application and external services are:

ServiceSoap.svc

Simple Object Access Protocol (SOAP) specification of the interface formatted as Extensible Markup Language (XML). ServiceSoap.svc uses BasicHttpBinding and all object types are formatted in PascalCase.

ServiceRestJson.svc

Representational State Transfer (REST) specification of the interface formatted as JavaScript Object Notation (JSON). ServiceRestJson.svc uses WebHttpBinding and all object types are formatted in PascalCase.

ServiceRestXml.svc

Representational State Transfer (REST) specification of the interface formatted as Extensible Markup Language (XML). ServiceRestXml.svc usrs WebHttpBinding and all object types are formatted in PascalCase.