CAS Integration 3B - Get Supplier & Update Existing Site

User Story:

As a Ministry user (Finance team), I want to keep supplier/site information in CAS up to date with the information we have in SIMS. When a student who has a Supplier/Site assigned to them, we need to update the address in CAS if they update their address with us. If we find a matching supplier/site for a new student and the mailing address (line 1) does not perfectly match the one we have in SIMs, we should create a new SITE for that supplier

Acceptance Criteria:

Get Supplier (Last Name and SIN)

[ ] Ensure initial Get Supplier call uses the follow name format to search:
- [ ] ALL upper case letters
- [ ] LASTNAME, % (% being a wildcard character)
- [ ] There must be a space after the comma
- [ ] Hyphens accepted, not dashes
- [ ] Not accepted, just omit: ^ ; [ ] " .
- [ ] Special characters: ((WAITING ON CAS CONFIRMATION))
- Examples:
  - ANDERSON, BETTY for Betty Anderson
  - SMITH, MURRAY L for Murray L Smith
  - SHAW-MCLAREN, JAMES for James Shaw-McLaren

Get Supplier Response - Found & Active

[ ] Save Supplier Number, Supplier Status, and if it's protected.

[ ] Create New Site: https://< webserviceURL >:<port_no>/ords/cas/cfs/supplier/:snum/site

{
"SupplierNumber":"2002492", 
"SupplierAddress":[
{
"AddressLine1":"3350 CLEARBROOK RD", 
"City":"ABBOTSFORD", 
"Province":"BC", 
"Country":"CA", 
"PostalCode":"V2T4T4", 
"EmailAddress":"abc@xyz.com", 
"EftAdvicePref":"E"
}]}

[ ] Address: Only use Address Line 1. 2 & 3 are optional. Remove special characters including periods.
[ ] Country code: Use CA for Canada and US for USA. Any other countries leave blank, expected error for manual entry (error handling)
[ ] Postal code: No spaces, can use zip code
[ ] Successful Create Site Response: Save Site Number, Set to Valid, Save all other site details attached to it.
[ ] UnSuccessful Create Site Response: Will be done as part of error handling

Get Supplier Response - Not Found OR Not Active

Should be addressed with regular Create Supplier & Site on CAS 3A

Update Existing Supplier Site

When a student updates their address (address line 1, city, postal code, or country) or email address:

[ ] Site status is Protected: Do nothing, will be manually addressed through error handling (Refer to ticket #3258)
[ ] Site status is NOT Protected: Execute the "Update Existing Supplier Site" transaction

[ ] UPDATE using https://< webserviceURL >:<port_no>/ords/cas/cfs/supplier/:snum/site/update :

{
"SupplierNumber":"2002492",
"SupplierAddress":[
 {
    "SupplierSiteCode":"001",
    "AddressLine1":"3350 CLEARBROOK RD",
    "City":"ABBOTSFORD",
    "Province":"BC",
    "Country":"CA",
    "PostalCode":"V2T4T4",
    "EmailAddress":"abc@xyz.com",
    "EftAdvicePref":"E"
 }  ]}

[ ] The same Address Line 1, Province, Country, and Postal Code rules from the "Create Supplier Site" information above apply.

Technical Context

Sample CURL to create

curl --location '${BASEURL}/cfs/supplier/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
    SupplierName: '\''Skywalker, Leia'\'',
    SubCategory: '\''Individual'\'',
    Sin: '\''422233197'\'',
    SupplierAddress: [
    {
        AddressLine1: '\''1012 Douglas St'\'',
        City: '\''Victoria'\'',
        Province: '\''BC'\'',
        Postalcode: '\''V8W 2C3'\'',
        Country: '\''Canada'\'',
        EmailAddress: '\''stephen.laws@gov.bc.ca'\'',
    }]
}'

Response:

{"SUPPLIER_NUMBER":"2007638","SUPPLIER_SITE_CODE":"[001] ","CAS-Returned-Messages":"SUCCEEDED"}

Business Context Supplier Web Service RESTful Client Onboarding v02_01.pdf Individual Supplier Web Service Field Requirements (All Requests) JAN2023.xlsx

Update Existing Supplier Site

Command 2 { "SupplierNumber":"2002492", "SupplierAddress":[ { "SupplierSiteCode":"001", "AddressLine1":"3350 CLEARBROOK RD", "AddressLine2":"", "AddressLine3":"", "City":"ABBOTSFORD", "Province":"BC", "Country":"CA", "PostalCode":"V2T4T4", "EmailAddress":"abc@xyz.com", "EftAdvicePref":"E" } ] }

Success Response: { "Supplier_Number":"123456789", "Supplier_Site_Code":"001", "CAS-Returned-Messages":"SUCCESS" }

Error Response { "Supplier_Number":"123456789", "Supplier_Site_Code":"001", "CAS-Returned-Messages":"Error Message" }

bcgov / SIMS