SideCore API
v1.1
OAS 3.0.1

System61.Sidecore.App.S61Api

Client Libraries

Addresses

​

Addresses allow you to manage address data and can pertain to an individual or business entity. Addresses are pretty straightforward, but can be used in a variety of ways depending on your needs.

Addresses Operations

/v1.1/addresses

​
Body
  • tableName
    Type:string | null
    read-only
  • id
    Type:integer Format: int32

    Signed 32-bit integers (commonly used integer type).

  • financialInstitutionGuid
    Type:string
    min: 
    1
    required
  • financialInstitutionBrandGuid
    Type:string
    min: 
    1
    required
  • addressLine1
    Type:string
    min: 
    1
    required
  • addressLine2
    Type:string | null
  • addressType
    Type:string
    min: 
    1
    required
  • addressTypeGuid
    Type:string
    min: 
    1
    required
  • localMunicipality
    Type:string | null
  • city
    Type:string
    min: 
    1
    required
  • state
    Type:string
    min: 
    1
    required
  • postalArea
    Type:string
    min: 
    1
    required
  • country
    Type:string
    min: 
    1
    required
  • latitude
    Type:number Format: double
  • longitude
    Type:number Format: double
  • createdDate
    Type:string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • createdBy
    Type:string | null
  • error
    Type:boolean
  • errorMessage
    Type:string | null
Responses
Request Example forPOST/v1.1/addresses
curl /v1.1/addresses \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "financialInstitutionGuid": "",
  "financialInstitutionBrandGuid": "",
  "addressLine1": "",
  "addressLine2": null,
  "addressType": "",
  "addressTypeGuid": "",
  "localMunicipality": null,
  "city": "",
  "state": "",
  "postalArea": "",
  "country": "",
  "latitude": 1,
  "longitude": 1,
  "createdDate": "",
  "createdBy": null,
  "error": true,
  "errorMessage": null
}'

{
  "valid": true,
  "validationResponseGuid": null,
  "validationMessage": null,
  "validationException": null,
  "validationHttpResponseMessage": {
    "version": "…",
    "content": {
      "headers": [
        {
          "key": "…",
          "value": [
            "…"
          ]
        }
      ]
    },
    "statusCode": "Continue",
    "reasonPhrase": null,
    "headers": [
      {
        "key": "…",
        "value": [
          "…"
        ]
      }
    ],
    "trailingHeaders": [
      {
        "key": "…",
        "value": [
          "…"
        ]
      }
    ],
    "requestMessage": {
      "version": "…",
      "versionPolicy": "RequestVersionOrLower",
      "content": {
        "headers": [
          {
            "key": "…",
            "value": [
              "…"
            ]
          }
        ]
      },
      "method": {
        "method": "…"
      },
      "requestUri": null,
      "headers": [
        {
          "key": "…",
          "value": [
            "…"
          ]
        }
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "isSuccessStatusCode": true
  },
  "errorCodes": [
    "…"
  ],
  "validationResponseID": 1
}

Created

Brands (Collapsed)

​
Brands Operations

Businesses (Collapsed)

​
Businesses Operations

Models