NORTHPOINTE SUITE WEB SERVICES ARCHITECTURE

Size: px

Start display at page:

Download "NORTHPOINTE SUITE WEB SERVICES ARCHITECTURE"

Cassandra Norton
5 years ago
Views:

1 NORTHPOINTE SUITE WEB SERVICES ARCHITECTURE

2 Table of Contents LDAP LOGIN 2 APPLICATION LOGIN 4 LIST REFERENCE CODES 9 STORE REFERENCE CODES 14 LIST AGENCIES 18 GET AGENCY ID 23 LIST SECURITY GROUPS 27 GET SECURITY GROUP ID 32 GET USER ID 37 STORE USER 42 STORE OFFENDER 48 Northpointe Evolving Practice Through Scientific Innovation 1

3 LDAP LOGIN Overview The main purpose of this use case is to create an alternative login process by validating user accounts against LDAP and Northpointe Suite. Measurable Result Actor successfully logs into the application Flow of Events Actor will access COMPAS thru a LDAP specific entry point. Actor s credentials are validated and a list of the actor s group memberships is returned to application. The system will check to see if the actor is a member of a group that matches a security group in COMPAS. If the actor is a member of a COMPAS security group the system will validate the actor s LDAP account information against a COMPAS user account and log them into the application. If the actor does not yet have an account in COMPAS, the system will create a new account using the actor s LDAP properties. If the actor is not a member to a group that matches a security group in COMPAS they will not be allowed access to COMPAS. Northpointe Evolving Practice Through Scientific Innovation 2

5 SERVICES APPLICTION LOGIN Overview The main purpose of this use case is to expose a web service that logs the user into a specific application and return the url needed for the actor to redirect to the application home page. Measurable Result Actor successfully logs into the application Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate actor s credentials. If credentials are valid the system will create a session inside the application and return a full URL that will be used to redirect the user into the application. If credentials are not valid the web service will return an error code. Web Service Name NPuserServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Application_ID Integer X UserName String X Password String X IsPasswordEncrypted RedirctToPage Boolean String Northpointe Evolving Practice Through Scientific Innovation 4

6 Services Application LOGIN Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Application_ID Protected key that is required to invoke the web service Identifies the client Identifies the application trying to login to AppInfo Value Customer Rec_ID Sys_Application Rec_ID UserName Password IsPasswordEncrypted RedirectToPage Web Service Return User Name Password Boolean value to state if password being passed into method is encrypted or not. Page name of desired page redirect. Defaults to home.aspx. False See Northpointe for implementation details if other than home page Upon successfully completion of login procedure the web service will return the following string value Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message url needed to access application Default is an empty string Northpointe Evolving Practice Through Scientific Innovation 5

7 Services Application LOGIN Web Service Error Codes If the system encounters an error the web service will return and error code and description. Format for error code is as follows Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 Invalid Username or Password 104 Expired or inactive account 105 Account does not have access to application 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 6

8 Services Application LOGIN Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npuserservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetUserID xmlns=" <ServiceKey>string</ServiceKey> <CustomerID>string</CustomerID> < >string</ > </GetUserID> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetUserIDResponse xmlns=" <GetUserIDResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </GetUserIDResult> </GetUserIDResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 7

9 Services Application LOGIN Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue>1</ReturnValue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid </message> <ErrorCode>102</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 8

10 SERVICES LIST REFERENCE CODES Overview The main purpose of this use case is to expose a web service that returns a dataset of all the reference codes by type. Measurable Result Reference code dataset is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return a reference code dataset. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required ServiceKey String X Customer_ID String X Type_ID Integer X Northpointe Evolving Practice Through Scientific Innovation 9

11 Services List Reference Codes Table 2: Parameter Details Item Description Database/Table/Field ServiceKey Customer_ID Protected key that is required to invoke the web service Identifies the client Type_ID Indentifies what reference code type AppInfo Value Customer Rec_ID Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description Dataset of all active agencies. Name and Rec_ID ErrorCode Default is 0 ReturnValue Message Default is an empty string Default is an empty string Web Service Error Codes If the system encounters an error, the web service will return an empty dataset with an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Service Key 101 Invalid Customer_ID 102 Invalid Type_ID 103 No Codes Found for Type_ID 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 10

12 Services List Reference Codes Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npconfigurationservices.asmx HTTP/1.1 Host: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetReferenceCodes xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Type_ID>int</Type_ID> </GetReferenceCodes> </soap:body> </soap:envelope> HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetReferenceCodesResponse xmlns=" <GetReferenceCodesResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </GetReferenceCodesResult> </GetReferenceCodesResponse> </soap:body> </soap:envelope> Northpointe Evolving Practice Through Scientific Innovation 11

13 Services List Reference Codes Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue /> - <Dataset> - <xs:schema id="ref_code" xmlns="" xmlns:xs=" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> - <xs:element name="ref_code" msdata:isdataset="true" msdata:usecurrentlocale="true"> - <xs:complextype> - <xs:choice minoccurs="0" maxoccurs="unbounded"> - <xs:element name="ref_codes"> - <xs:complextype> - <xs:sequence> <xs:element name="text" type="xs:string" minoccurs="0" /> <xs:element name="refstring" type="xs:string" minoccurs="0" /> <xs:element name="order" type="xs:int" minoccurs="0" /> <xs:element name="isactive" type="xs:boolean" minoccurs="0" /> <xs:element name="islocked" type="xs:boolean" minoccurs="0" /> </xs:sequence> </xs:complextype> </xs:element> </xs:choice> </xs:complextype> </xs:element> </xs:schema> - <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"> - <Ref_Code xmlns=""> - <Ref_Codes diffgr:id="ref_codes1" msdata:roworder="0" diffgr:haschanges="inserted"> <Text>General</Text> <RefString /> <Order>1</Order> <IsActive>true</IsActive> <IsLocked>true</IsLocked> </Ref_Codes> </Dataset> </Response> Northpointe Evolving Practice Through Scientific Innovation 12

14 Services List Reference Codes Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>no codes found for type_id</message> <ErrorCode>103</ErrorCode> <ReturnValue /> </Response> SERVICES STORE REFERENCE CODES Northpointe Evolving Practice Through Scientific Innovation 13

15 Overview The main purpose of this use case is to expose a web service that creates/update a reference code value. Measurable Result Record is created or updated Flow of Events System will expose a web service method, requiring specific parameters, to create or update a list of reference code. Once web service is invoked the system will validate all parameters. System will then use parameters to create/modify the records. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Type_ID Integer X RefCodeDataSet Dataset X Services Store Reference Codes Northpointe Evolving Practice Through Scientific Innovation 14

16 Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Type_ID RefCodeDataSet Protected key that is required to invoke the web service Identifies the client Reference Code Dataset Schema Indentifies the Code Type trying to update codes for. Dataset of reference codes that need to be created or updated AppInfo Value Customer Rec_ID See List below See below Column Type Description Text String Text value of item Order Integer Order of which you want displayed RefString String Internal reference code used to uniquely identify code text IsDeleted Boolean Should this code be deleted? IsActive Boolean Is this code active? IsLocked Boolean <?xml version="1.0" standalone="yes"?> <Ref_Code> <Ref_Code> <Text>Example #1</Text> <RefString>REQ_NOTIF1</RefString > <Order>1</Order> <IsLocked>true</IsLocked> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Ref_Code> <Ref_Code> <Text>Example #2</Text> <RefString>REQ_NOTIF2</RefString > <Order>2</Order> <IsLocked>true</IsLocked> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Ref_Code> </Ref_Code> Services Store Reference Code Is this code locked and cannot be edited thru COMPAS? Northpointe Evolving Practice Through Scientific Innovation 15

17 Reference Code Types Name Type_ID Description Release Date Type Valid ID DAPO Notes Release Date Type Valid ID Veteran Status Highest Level of Education Completed Controlling Offenses Non-Controlling Offenses Static-99 Score Drug of Choice Drug Method of Use Alcohol use Relationship Gang Status Serious RVR Charge Source Documents in File TB Code Mental Health Screening Recommendation for Adaptive Support Indicated MDO Screening Indicated TABE Score TABE Per Hold/Warrants/Detainers Prior Serious Current Work Skills Voc Training Desired Veteran Status Highest level of education completed Controlling Offenses Non-Controlling Offenses Static 99 Score Drug of Choice Drug Method of Use Alcohol Use Relationship to the client Gang Status Serious RVR (CDC 115) Charge Source Documents in File TB Code Mental Health Screening Recommendation for Adaptive Support Indicated MDO Screening Indicated TABE Score TABE Per Holds, Warrants, Detainers Prior serious (PC & PC ) or Violent Current Work Skills Vocation Training Desired Services Store Reference Code Northpointe Evolving Practice Through Scientific Innovation 16

18 Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message User ID record of record created or updated Default is an empty string Web Service Error Codes If the system encounters an error the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Type_ID 103 Invalid RefCodeDataSet Schema - Text 104 Invalid RefCodeDataSet Schema - Order 105 Invalid RefCodeDataSet Schema - RefString 106 Invalid RefCodeDataSet Schema - IsDeleted 900 UnExpected Error SERVICES LIST AGENCIES Northpointe Evolving Practice Through Scientific Innovation 17

19 Overview The main purpose of this use case is to expose a web service that returns a dataset of all the active Agencies. Measurable Result Agency dataset is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return a agency dataset. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required ServiceKey String X Customer_ID String X Table 2: Parameter Details Item Description Database/Table/Field ServiceKey Customer_ID Protected key that is required to invoke the web service Identifies the client AppInfo Value Customer Rec_ID Services List Agencies Northpointe Evolving Practice Through Scientific Innovation 18

20 Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description Dataset of all active agencies. Name and Rec_ID ErrorCode Default is 0 ReturnValue Message Default is an empty string Default is an empty string Web Service Error Codes If the system encounters an error, the web service will return an empty dataset with an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Service Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 No Active Agencies 900 UnExpected Error Services List Agencies Northpointe Evolving Practice Through Scientific Innovation 19

21 Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npconfigurationservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetAgencies xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> </GetAgencies> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetAgenciesResponse xmlns=" <GetAgenciesResult> <Message>string</Message> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> </GetAgenciesResult> </GetAgenciesResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 20

22 Services List Agencies Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue /> - <Dataset> - <xs:schema id="agency" xmlns="" xmlns:xs=" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> - <xs:element name="agency" msdata:isdataset="true" msdata:usecurrentlocale="true"> - <xs:complextype> - <xs:choice minoccurs="0" maxoccurs="unbounded"> - <xs:element name="agencies"> - <xs:complextype> - <xs:sequence> <xs:element name="rec_id" type="xs:int" minoccurs="0" /> <xs:element name="customer_id" type="xs:string" minoccurs="0" /> <xs:element name="name" type="xs:string" minoccurs="0" /> <xs:element name="description" type="xs:string" minoccurs="0" /> <xs:element name="isactive" type="xs:boolean" minoccurs="0" /> <xs:element name="isdeleted" type="xs:boolean" minoccurs="0" /> <xs:element name="ishidden" type="xs:boolean" minoccurs="0" /> </xs:sequence> </xs:complextype> </xs:element> </xs:choice> </xs:complextype> </xs:element> </xs:schema> - <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"> - <Agency xmlns=""> - <Agencies diffgr:id="agencies1" msdata:roworder="0" diffgr:haschanges="inserted"> <Rec_ID>8</Rec_ID> <Customer_ID>e254c4df486e430bb4278c3c9b59d4c0</Customer_ID> <Name>Test Agency</Name> <Description>Test Agency Description</Description> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> <IsHidden>false</IsHidden> </Agencies> - <Agencies diffgr:id="agencies2" msdata:roworder="1" diffgr:haschanges="inserted"> <Rec_ID>1</Rec_ID> <Customer_ID>e254c4df486e430bb4278c3c9b59d4c0</Customer_ID> <Name>Test Agency 1</Name> <Description>Test Agency 1</Description> Northpointe Evolving Practice Through Scientific Innovation 21

23 Services List Agencies <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> <IsHidden>false</IsHidden> </Agencies> - <Agencies diffgr:id="agencies3" msdata:roworder="2" diffgr:haschanges="inserted"> <Rec_ID>4</Rec_ID> <Customer_ID>e254c4df486e430bb4278c3c9b59d4c0</Customer_ID> <Name>Test Agency 2</Name> <Description>Test Agency 2</Description> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> <IsHidden>false</IsHidden> </Agencies> </Agency> </diffgr:diffgram> </Dataset> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>Invalid service key.</message> <ErrorCode>100</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 22

24 SERVICES GET AGENCY ID Overview The main purpose of this use case is to expose a web service that returns an ID for a agency record by agency name. Measurable Result Agency ID is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return an Agency ID. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X AgencyName String X Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Protected key that is required to invoke the web service Identifies the client AppInfo Value Customer Rec_ID AgencyName Services Get Agency ID Name of Agency Northpointe Evolving Practice Through Scientific Innovation 23

25 Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message Agency ID Default is an empty string Web Service Error Codes If the system encounters an error, the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 Invalid Agency Name 104 Agency is not active 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 24

26 Services Get Agency ID Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npconfigurationservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetAgencyID xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <AgencyName>string</AgencyName> </GetAgencyID> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetAgencyIDResponse xmlns=" <GetAgencyIDResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </GetAgencyIDResult> </GetAgencyIDResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 25

27 Services Get Agency ID Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue>23</ReturnValue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid agency</message> <ErrorCode>102</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 26

28 SERVICES LIST SECURITY GROUPS Overview The main purpose of this use case is to expose a web service that returns a dataset of all the active security groups Measurable Result Security group dataset is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return a security group dataset. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Application_ID Integer X Services List Security Groups Northpointe Evolving Practice Through Scientific Innovation 27

29 Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Application_ID Web Service Return Protected key that is required to invoke the web service Identifies the client Identifies the application trying to login to AppInfo Value Customer Rec_ID Sys_Application Rec_ID Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description Dataset of all active security groups. Name and Rec_ID ErrorCode Default is 0 ReturnValue Message Default is an empty string Default is an empty string Web Service Error Codes If the system encounters an error, the web service will return an empty dataset with an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 No Active Security Groups 900 UnExpected Error Services List Security Groups Northpointe Evolving Practice Through Scientific Innovation 28

30 Soap 1.2 Response and Request Schema POST /northpointeservices/npconfigurationservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetGroups xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Application_ID>int</Application_ID> </GetGroups> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetGroupsResponse xmlns=" <GetGroupsResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </GetGroupsResult> </GetGroupsResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 29

31 Services List Security Groups Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue /> - <Dataset> - <xs:schema id="group" xmlns="" xmlns:xs=" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> - <xs:element name="group" msdata:isdataset="true" msdata:usecurrentlocale="true"> - <xs:complextype> - <xs:choice minoccurs="0" maxoccurs="unbounded"> - <xs:element name="groups"> - <xs:complextype> - <xs:sequence> <xs:element name="rec_id" type="xs:int" minoccurs="0" /> <xs:element name="name" type="xs:string" minoccurs="0" /> <xs:element name="description" type="xs:string" minoccurs="0" /> <xs:element name="ranking" type="xs:int" minoccurs="0" /> <xs:element name="isglobal" type="xs:boolean" minoccurs="0" /> <xs:element name="isactive" type="xs:boolean" minoccurs="0" /> <xs:element name="isdeleted" type="xs:boolean" minoccurs="0" /> </xs:sequence> </xs:complextype> </xs:element> </xs:choice> </xs:complextype> </xs:element> </xs:schema> - <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"> - <Group xmlns=""> - <Groups diffgr:id="groups1" msdata:roworder="0" diffgr:haschanges="inserted"> <Rec_ID>1</Rec_ID> <Name>Global Adminstrator</Name> <Description>Global Adminstrator</Description> <Ranking>0</Ranking> <IsGlobal>false</IsGlobal> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Groups> - <Groups diffgr:id="groups2" msdata:roworder="1" diffgr:haschanges="inserted"> <Rec_ID>2</Rec_ID> <Name>Site Administrator</Name> <Description>Site Administrator</Description> Northpointe Evolving Practice Through Scientific Innovation 30

32 Services List Security Groups <Ranking>1</Ranking> <IsGlobal>false</IsGlobal> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Groups> - <Groups diffgr:id="groups3" msdata:roworder="2" diffgr:haschanges="inserted"> <Rec_ID>5</Rec_ID> <Name>Power Users</Name> <Description>Powers Users</Description> <Ranking>2</Ranking> <IsGlobal>false</IsGlobal> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Groups> - <Groups diffgr:id="groups4" msdata:roworder="3" diffgr:haschanges="inserted"> <Rec_ID>19</Rec_ID> <Name>Test Group</Name> <Description>Test Group</Description> <Ranking>1</Ranking> <IsGlobal>false</IsGlobal> <IsActive>true</IsActive> <IsDeleted>false</IsDeleted> </Groups> </Group> </diffgr:diffgram> </Dataset> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid application id</message> <ErrorCode>102</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 31

33 SERVICES GET SECURITY GROUP ID Overview The main purpose of this use case is to expose a web service that returns an ID for a group record by group name. Measurable Result Security group id is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return a security group id. If parameter validation is not successful, the web service will return an error code. Web Service Name NPConfigurationServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Application_ID Integer X GroupName String X Services Get Security Group ID Northpointe Evolving Practice Through Scientific Innovation 32

34 Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Application_ID Protected key that is required to invoke the web service Identifies the client Identifies the application trying to login to AppInfo Value Customer Rec_ID Sys_Application Rec_ID GroupName Name of the security group Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message Requested Security Group ID Default is an empty string Services Get Security Group ID Northpointe Evolving Practice Through Scientific Innovation 33

35 Web Service Error Codes If the system encounters an error, the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Service Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 Invalid Group Name 104 Group Name is not active 900 UnExpected Error Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npconfigurationservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetGroupID xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Application_ID>int</Application_ID> <GroupName>string</GroupName> </GetGroupID> </soap12:body> </soap12:envelope> Services Get Security Group ID Northpointe Evolving Practice Through Scientific Innovation 34

36 HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <GetGroupIDResponse xmlns=" <GetGroupIDResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </GetGroupIDResult> </GetGroupIDResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 35

37 Services Get Security Group ID Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue>5</ReturnValue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid group name</message> <ErrorCode>103</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 36

38 SERVICES GET USER ID Overview The main purpose of this use case is to expose a web service that returns an ID for a user record by a username or address. Measurable Result User id is returned Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to return a security group id. If parameter validation is not successful, the web service will return an error code. Web Service Name NPuserServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Key String X Customer_ID String X String X Northpointe Evolving Practice Through Scientific Innovation 37

39 Services Get User ID Table 2: Parameter Details Item Description Database/Table/Field Key Customer_ID Protected key that is required to invoke the web service Identifies the client AppInfo Value Customer Rec_ID Users address Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message Requested User ID Default is an empty string Northpointe Evolving Practice Through Scientific Innovation 38

40 Services Get User ID Web Service Error Codes If the system encounters an error, the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Address 103 Account is not active 104 Account has been deleted 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 39

41 Services Get User ID Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npuserservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <LoginUser xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Application_ID>int</Application_ID> < >string</ > <Password>string</Password> <IsPasswordEncrypted>boolean</IsPasswordEncrypted> <RedirectToPage>string</RedirectToPage> </LoginUser> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <LoginUserResponse xmlns=" <LoginUserResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </LoginUserResult> </LoginUserResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 40

42 Services Get User ID Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue> sqqjmsghe61siye8cgfnbjlfsg1k3l6qbsnagqmwaqbst0tawa%3d&page=home.as px</returnvalue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid login credentials</message> <ErrorCode>103</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 41

43 SERVICES STORE USER Overview The main purpose of this use case is to expose a web service that stores a user record. Measurable Result User record is saved Flow of Events System will expose a web service method, requiring specific parameters, to create a new user record. Once web service is invoked the system will validate all parameters. System will then use parameters to create a new user. If parameter validation is not successful, the web service will return an error code. If address already exists, the system will update the offender attached to the specific address. If username already exists, the system will update the offender attached to the specific username. Web Service Name NPUserServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Application_ID Integer X CreatedBy_User_ID Integer X Agency String X Services Store User Northpointe Evolving Practice Through Scientific Innovation 42

44 Table 1: Parameter List - continued Item Type Required FirstName String X LastName String X MiddleInitial String String X UserName String X Password String X Group_ID Integer X IsConfAdmin Boolean X IsScreener Boolean X Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Application_ID CreatedBy_User_ID Agency Services Store User Protected key that is required to invoke the web service Identifies the client Identifies the application the user belongs too ID of user creating the user Agency the user is located at AppInfo Value Customer Rec_ID Sys_Application Rec_ID User Rec_ID Agency Name Northpointe Evolving Practice Through Scientific Innovation 43

45 Table 2: Parameter Details - continued Item Description Database/Table/Field FirstName First name of user LastName MiddleInitial Last Name of user Middle Initial of user address of user UserName Username of User * Password Group_ID IsConfAdmin IsScreener Password for user Security group that user will belong too Is this user a high level system administrator Is this user a screener Group Rec_ID * address replaces username in all suite products Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message User ID record of record created or updated Default is an empty string Northpointe Evolving Practice Through Scientific Innovation 44

46 Services Store User Web Service Error Codes If the system encounters an error the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 Invalid CreatedBy_User_ID 104 Invalid Agency 105 Invalid 106 Invalid Password Length, Minimum of 6 characters 107 Invalid Group ID 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 45

47 Services Store User Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npuserservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <StoreUser xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Application_ID>int</Application_ID> <CreatedBy_User_ID>int</CreatedBy_User_ID> <Agency_ID>int</Agency_ID> <FirstName>string</FirstName> <LastName>string</LastName> <MiddleInitial>string</MiddleInitial> < >string</ > <Password>string</Password> <Group_ID>int</Group_ID> <IsScreener>boolean</IsScreener> </StoreUser> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <StoreUserResponse xmlns=" <StoreUserResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </StoreUserResult> </StoreUserResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 46

48 Services Store User Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue>4561</ReturnValue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid password length</message> <ErrorCode>102</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 47

49 Services Store Offender Overview The main purpose of this use case is to expose a web service that stores an offender record. Measurable Result Offender record is stored Flow of Events System will expose a web service method requiring specific parameters. Once web service is invoked the system will validate all parameters. System will then take parameters to create a new offender. If parameter validation is not successful, the web service will return an error code. If offender number already exists, the system will update the offender attached to the specific offender number. Web Service Name NPOffenderServices.asmx Web Service Parameters Table 1: Parameter List Item Type Required Service Key String X Customer_ID String X Application_ID Integer X CreatedBy_User_ID Integer X Agency String X FirstName String X LastName String X MiddleName String OffenderNumber String X AltOffenderNumber String DateOfBirth String X Ethnicity String X Gender String X SSN String Northpointe Evolving Practice Through Scientific Innovation 48

50 Services Store Offender Table 2: Parameter Details Item Description Database/Table/Field Service Key Customer_ID Application_ID CreatedBy_User_ID Agency Protected key that is required to invoke the web service Identifies the client Identifies the application trying to login to ID of user creating the offender Agency offender is located at AppInfo Value Customer Rec_ID Sys_Application Rec_ID User Rec_ID Agency Name FirstName LastName MiddleName OffenderNumber AltOffenderNumber DateOfBirth Ethnicity Gender SSN First Name of Offender Last Name of Offender Middle Name of Offender Offender Number (CDC) Alternate Offender Number Date of Birth of Offender Ethnicity of Offender Gender of Offender Social Security Number of Offender Sys_Code Text Sys_Code Text Northpointe Evolving Practice Through Scientific Innovation 49

51 Services Store Offender Web Service Return Upon successfully completion of procedure the web service will return the following string value. Type DataSet Description NULL ErrorCode Default is 0 ReturnValue Message Offender ID created or edited Default is an empty string Web Service Error Codes If the system encounters an error, the web service will return an error code and description. Format for error code is as follows: Error Code Description 100 Invalid Key 101 Invalid Customer_ID 102 Invalid Application_ID 103 Invalid CreatedBy_User_ID 104 Invalid Agency 105 Offender Number already exists 106 Invalid Date of Birth 107 Invalid Ethnicity 108 Invalid Gender 109 Invalid Social Security Number 110 Social Security Number already exists 900 UnExpected Error Northpointe Evolving Practice Through Scientific Innovation 50

52 Services Store Offender Soap 1.2 Response and Request Schema The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /northpointeservices/npoffenderservices.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <StoreReEntrytOffender xmlns=" <ServiceKey>string</ServiceKey> <Customer_ID>string</Customer_ID> <Application_ID>int</Application_ID> <CreatedBy_User_ID>int</CreatedBy_User_ID> <AgencyName>string</AgencyName> <FirstName>string</FirstName> <LastName>string</LastName> <MiddleName>string</MiddleName> <OffenderNumber>string</OffenderNumber> <AltOffenderNumber>string</AltOffenderNumber> <DateOfBirth>string</DateOfBirth> <Ethnicity>string</Ethnicity> <Gender>string</Gender> <SSN>string</SSN> </StoreReEntrytOffender> </soap12:body> </soap12:envelope> HTTP/ OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap12=" <soap12:body> <StoreReEntrytOffenderResponse xmlns=" <StoreReEntrytOffenderResult> <Message>string</Message> <ErrorCode>int</ErrorCode> <ReturnValue>string</ReturnValue> <Dataset> <xsd:schema>schema</xsd:schema>xml</dataset> </StoreReEntrytOffenderResult> </StoreReEntrytOffenderResponse> </soap12:body> </soap12:envelope> Northpointe Evolving Practice Through Scientific Innovation 51

53 Services Store Offender Sample of Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message /> <ErrorCode>0</ErrorCode> <ReturnValue>1009</ReturnValue> </Response> Sample of Un-Successful Invoke <?xml version="1.0" encoding="utf-8"?> - <Response xmlns:xsi=" xmlns:xsd=" xmlns=" <Message>invalid application id</message> <ErrorCode>102</ErrorCode> <ReturnValue /> </Response> Northpointe Evolving Practice Through Scientific Innovation 52

NO: 22/15(1)/ /DCH/DHDS/Machinery Government of India Ministry of Textiles Office of the Development Commissioner for Handlooms **** ADDENDUM

NO: 22/15(1)/ /DCH/DHDS/Machinery Government of India Ministry of Textiles Office of the Development Commissioner for Handlooms **** ADDENDUM NO: 22/15(1)/2014-15/DCH/DHDS/Machinery Government of India Ministry of Textiles Office of the Development Commissioner for Handlooms **** ADDENDUM Udyog Bhavan, New Delhi Dated: 27.10.2014 Subject: -