NCDA_NCIDWS Web Service

NCDA_NCIDWS

Click here for a complete list of operations.

AuthenticateNCIDReturnStatus

Authenticates a NCID and password only. Checks local first and then if that is not successful check NCID Web service. If valid authentication takes place, copies information locally. Returns status: Success = 0 InvalidUsername = 101 AccountDisabled = 102 InvalidPassword = 103 PasswordExpired = 111 LockedOut = 113 WSException = -1

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Library/NCDAServices/NCDA_NCIDWS.asmx HTTP/1.1
Host: apps.ncagr.gov
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://APPS.NCAGR.GOV/NCDAServices/AuthenticateNCIDReturnStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateNCIDReturnStatus xmlns="https://APPS.NCAGR.GOV/NCDAServices/">
      <username>string</username>
      <password>string</password>
      <UsageKey>string</UsageKey>
    </AuthenticateNCIDReturnStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateNCIDReturnStatusResponse xmlns="https://APPS.NCAGR.GOV/NCDAServices/">
      <AuthenticateNCIDReturnStatusResult>int</AuthenticateNCIDReturnStatusResult>
    </AuthenticateNCIDReturnStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Library/NCDAServices/NCDA_NCIDWS.asmx HTTP/1.1
Host: apps.ncagr.gov
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AuthenticateNCIDReturnStatus xmlns="https://APPS.NCAGR.GOV/NCDAServices/">
      <username>string</username>
      <password>string</password>
      <UsageKey>string</UsageKey>
    </AuthenticateNCIDReturnStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AuthenticateNCIDReturnStatusResponse xmlns="https://APPS.NCAGR.GOV/NCDAServices/">
      <AuthenticateNCIDReturnStatusResult>int</AuthenticateNCIDReturnStatusResult>
    </AuthenticateNCIDReturnStatusResponse>
  </soap12:Body>
</soap12:Envelope>