bcs-locations-management-api-services

API INFORMATION

Title: locations-management-api-services

Version: 1.0.0

Protocols: HTTPS

URI Sandbox: https://locations-management-api-services-dev.us-e1.cloudhub.io/

URI QA:

URILive:

DOWLOAD RAML

DESCRIPTION

This service allows Management of Locations Information, which allows the following operations:

Summary

- Branch

Path:

GET

/locations-management/v1/branch:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Query Parameters:

flagActive: Flag indicating whether it is active or inactive

initialRecord: Indicates the pagination page number

recordsXPage: Indicates the number of records per page

Response information:

resultsPagesGeneric: Pagination Information

totalRecords: Total Number of Records
recordsXPage: Number of Records Returned

BranchList: Branch List

branchId: BranchId
branchName: BranchNBranch Cityame
zone: Branch Area
city: Branch City
address: Branch Address
cityId: Branch City Id
latitude: Branch Latitude
longitude: Branch Longitude
officeState: State Office

Example of Body to Response Successfull

{
  "resultsPagesGeneric": {
    "totalRecords": "240",
    "recordsXPage": "20"
  },
  "branchList": [
    {
      "branchId": "1102",
      "branchName": "Digital",
      "zone": "NUEVE",
      "city": "Bogotá",
      "address": "Cll 72 # 11 - 09",
      "cityId": "11001",
      "latitude": "4.707",
      "longitude": "-74.107",
      "officeState": "A"
    },
    {
      "branchId": "1103",
      "branchName": "PABLO VI",
      "zone": "NUEVE",
      "city": "Bogotá",
      "address": "AC 53 NO 52 BIS 16",
      "cityId": "11001",
      "latitude": "4.650597",
      "longitude": "-74.091067",
      "officeState": "A"
    }
  ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

- Address

Path:

POST

/locations-management/v1/address:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Body:

addressList: Address list.

addr1: Physical address to standardize

Example of Body to Address

{
"addressList": [
      {
        "addr1": "CALLE 1 112-12 - SAN-CARLOS-"
      },
      {
        "addr1": "CARRERA 1 16-42 --SAN-CARLOS--"
      }
   ]
}

Response information:

addressList: Address list.

addr1: Standardized address

Example of Body to Response Successfull

{
  "addressList": [
         {
           "addr1": "CL 1 112 12 SAN CARLOS"
         },
         {
           "addr1": "KR 1 16 42 SAN CARLOS"
         }
   ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

###

- Get Banks

Path:

GET

/locations-management/v1/banks:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Response information:

bankInfo: Information used to identify the bank

bankId: Code that identifies the bank
bankIdAch: Code that identifies the bank in ACH
bankName: Name of the bank
status: Current state of the bank
refInfo[]: Contains management information for electronic deposit, checking account and savings account

Example of Body to Response Successfull

{
    "bankInfo": [
        {
            "bankId": "00",
            "bankIdAch": "0000",
            "bankName": "Banco de la República",
            "status": true,
            "refInfo": [
                {
                    "value": false,
                    "desc": "MANEJA_DEPOSITO_ELECTRONICO"
                },
                {
                    "value": false,
                    "desc": "MANEJA_CC"
                },
                {
                    "value": false,
                    "desc": "MANEJA_CA"
                }
            ]
        },
        {
            "bankId": "01",
            "bankIdAch": "0001",
            "bankName": "Banco de Bogotá",
            "status": true,
            "refInfo": [
                {
                    "value": false,
                    "desc": "MANEJA_DEPOSITO_ELECTRONICO"
                },
                {
                    "value": true,
                    "desc": "MANEJA_CC"
                },
                {
                    "value": true,
                    "desc": "MANEJA_CA"
                }
            ]
        }
    ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

- Assignment Visitor (PUT):

Description:

Operation Assignment Visitor API.

Path:

/locations-management/v1/assignment-visit:

Headers:

Body:

>Request Mapping:

>Example-request:

{
  "custInfo": {
    "postAddr": {
      "addr1": "Calle 4",
      "latitude": "74°W",
      "longitude": "10°W",
      "postalCode": "23435",
      "flagGeoreferenced": "A",
      "flagAsign": "03"
    }
  },
  "pmtReferences":{
    "type":"01",
    "idItem":"122213",
    "createdDt": "2024-05-02",
    "priority":"A",
    "startDt":"2024-05-02",
    "relationshipId":"122213"
  }
}

>Response Mapping OK:

>Example-response:

 {
  "responseType": {
    "value": "OK"
  },
  "responseDetail": {
    "errorCode": "",
    "errorDesc": "",
    "errorType": ""
  },
  "adviser": {
    "user": "D2S7A2A0"
  },
  "custInfo": {
    "postAddr": {
      "zone": "135877",
      "city": "City  name",
      "flagGeoreferenced": "A",
      "flagAsign": "03"
    }
  }
}

>Response Mapping Error:

>Response Mapping Error:

{
  "responseType": {
    "value": "ERR500"
  },
  "responseDetail": {
    "errorCode": 500,
    "errorDesc": "The server encountered an unexpected condition which prevented it from fulfilling the request.",
    "errorType": "Internal Server Error"
  }
}

- Send Information Visit (POST):

Description:

Endpoint Send information Visit API.

Path:

/locations-management/v1/visit:

Headers:

Body:

>Request Mapping:

Mapping Request

*Campos reusados

>Example-request:

 {
  "pmtReferences": {
    "relationshipId": "254356456454",
    "idItem": "1577611657",
    "type": "ASALARIADO"
  },
  "businessInfo": {
    "postAddr": {
      "neighborhood": "Barrio example"
    },
    "jobTitle": "Enfermera",
    "startDt": "2025-02-05",
    "daysCycle": "Lunes;Martes;Miercoles",
    "prefTimeStart": "08:00",
    "prefTimeEnd": "18:00",
    "flagContractVerified": false,
    "labourContractType": "03",
    "additionalData": {
      "labourContractType": "01",
      "desc": "Example of reazon"
    }
  },
  "regPmtCurAmt": {
    "incomeInfo": [
      {
        "name": "salarioInformado",
        "amt": 25467000
      },
      {
        "name": "auxilioTransporte",
        "amt": 11000
      },
      {
        "name": "valorHorasExtra",
        "amt": 12000
      }
    ],
    "pmtReferences": {
      "pmtType": "CONSIGNACI",
      "freq": "04"
    },
    "bankInfo": {
      "name": "Name banck",
      "bankId": "55"
    },
    "flagReview": false,
    "reason": "No los muestran por seguridad."
  },
  "entprAgreement": {
    "adviser": {
      "adviserName": "Alejandro Cruz"
    },
    "businessGrade": "Tecnologa administrativo",
    "flagInscribedCC": false,
    "flagEvidenceCC": false
  },
  "conditionInfo": {
    "flagOwnerIsApplicant": false,
    "flagrelationShip": false,
    "relationshipType": "example",
    "contactName": {
      "fullName": "Name example"
    },
    "relationtInfo": {
      "relationshipType": "example"
    },
    "additionalData": {
      "type": "type example",
      "month": "1",
      "desc": " example place desc"
    },
    "flagRent": false,
    "vlrRentingMortagage": 10000,
    "flagValidate": false
  },
  "refInfo": {
    "flagExist": false,
    "flagBusinessActivity": false,
    "additionalData": [
      {
        "flagPropertyOccupied": false,
        "ownerInd": {
          "contactName": "Name example"
        },
        "additionalData": {
          "month": "2"
        },
        "required": "Example of required"
      }
    ],
    "businessInfo": {
      "businessActivity": {
        "desc": "example desc"
      },
      "month": "2",
      "ownerInd": {
        "contactName": "Name example"
      },
      "desc": "example desc"
    }
  },
  "entpr": {
    "flagExist": false,
    "flagRecognizeClient": false,
    "flagValidate": false,
    "desc": "example desc",
    "justExist": "just exist",
    "justRecognizeClient": "just Recognize Client",
    "justValidate": "just Validate"
  },
  "adviser": {
    "flagCanon": false,
    "flagAccordingSalary": false,
    "conceptAdvisorCode": "VEFECTUADA",
    "resultCode": "VEFAVORABL",
    "causalCode": "example",
    "upDt": "2024-05-24",
    "desc": "example desc",
    "contactInfo": {
      "action": "01",
      "reason": "reason example",
      "desc": "example desc"
    }
  },
  "additionalData": [
    {
      "key": "01",
      "value": "value",
      "idItem": "id item example"
    }
  ]
}

>Response Mapping OK:

>Response Mapping example OK:

{
  "responseType":{
    "value": "OK"
  }
}

>Response Mapping Error:

>Response Mapping example:

{
  "responseType": {
    "value": "ERR500"
  },
  "responseDetail": {
    "errorCode": 500,
    "errorDesc": "The server encountered an unexpected condition which prevented it from fulfilling the request.",
    "errorType": "Internal Server Error"
  }
}

- Information Visits

Description:

This service is about information visits

Path:

GET: /locations-management/v1/visit:

Request Data:

Headers:

Request Body:

Request Example:

{
}

Response Body:

Success Response Example:

{
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence

- Reassignment Visits

Description:

This service is about Reassignment visits

Path:

PUT:  /locations-management/v1/reassignment-visit:

Request Data:

Headers:

Request Body:

Request Example:

{
}

Response Body:

Success Response Example:

{
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence