POST Agents/Replication/CreateDefaultSatellite

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Replication/CreateDefaultSatellite

Set default values into a new Satellite.

NetServer calculates default values on the entity, which is required when creating/storing a new instance

Online Restricted: ## The Replication agent is not available in Online by default. Not available in Online. Only used on-site.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: Satellite

Property Name Type Description
SatelliteId int32 Primary key
Created date-time Registered when in UTC.
CreatedBy Associate Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Updated date-time Last updated when in UTC.
UpdatedBy Associate Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Contact Contact Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.
Area Area Carrier object for Area. Services for the Area Carrier is available from the Replication Agent.
LicenseOwners array The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Replication/CreateDefaultSatellite
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "SatelliteId": 565,
  "Created": "2021-12-23T14:13:41.1408128+01:00",
  "CreatedBy": null,
  "Updated": "2023-01-05T14:13:41.1408128+01:00",
  "UpdatedBy": null,
  "Contact": null,
  "Area": null,
  "LicenseOwners": [
    {
      "Name": "Sporer Inc and Sons",
      "Description": "Team-oriented 6th generation instruction set",
      "RestrictedModuleLicenses": [
        {},
        {}
      ],
      "UnrestrictedModuleLicenses": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 121
        }
      }
    },
    {
      "Name": "Sporer Inc and Sons",
      "Description": "Team-oriented 6th generation instruction set",
      "RestrictedModuleLicenses": [
        {},
        {}
      ],
      "UnrestrictedModuleLicenses": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 121
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 641
    }
  }
}