{
"openapi" : "3.0.1",
"info" : {
"contact" : {
"email" : "iot_technology_operations-m2m-api@telekom.de",
"name" : "Deutsche Telekom IoT GmbH",
"url" : "https://iot.telekom.com/en"
},
"description" : "This API allows customers to administrate their SIMs belonging to the M2M Service Portal 3.0.",
"license" : {
"name" : "Legal Notice",
"url" : "https://iot.telekom.com/en/legal-notice"
},
"termsOfService" : "false",
"title" : "M2M Customer API REST Service",
"version" : "1.0.0",
"x-api-category" : "DT IoT"
},
"externalDocs" : {
"description" : "Data Privacy",
"url" : "https://portal-m2m.telekom.de/m2m-customer-portal/privacy"
},
"servers" : [ {
"url" : "https://serverRoot/iot/connectivity/management/v1"
} ],
"tags" : [ {
"description" : "Root Controller",
"name" : "roots"
}, {
"description" : "Customers Related",
"name" : "customers"
}, {
"description" : "SIM Related",
"name" : "sims"
}, {
"description" : "SIM Transfer Related (* optional service)",
"name" : "sim-transfer"
} ],
"paths" : {
"/v1" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call gets a list of links for further actions of version 1.\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "getRootInfo",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"Root" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"info" : "string"
}
},
"schema" : {
"$ref" : "#/components/schemas/RootResource"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get Root Info for Version 1",
"tags" : [ "roots" ]
}
},
"/v1/partners" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call answers with the list of all assigned customers and subunits.\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "getCustomers",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"User" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"allocatedCustomerList" : [ {
"allocatedCustomer" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"companyName" : "string",
"isSubunitOf" : "string",
"partnerId" : "string"
}
} ],
"email" : "string",
"firstName" : "string",
"lastName" : "string",
"login" : "string",
"userName" : "string"
}
},
"schema" : {
"$ref" : "#/components/schemas/GetCustomersResultParameters"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get all allocated Customers from a specific User ID",
"tags" : [ "customers" ]
}
},
"/v1/partners/{partnerId}" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the numbers of SIM cards in specific states, and also link(s) to the SIM List resource containing the proper filter settings if at least one SIM card is in the corresponding state.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimStates",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"simStates" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"criticalSims" : {
"blockedAutomatically" : 0,
"blockedManually" : 0,
"suspended" : 0,
"undefined" : 0
},
"fraudState" : {
"alarm" : 0,
"noFraudProfile" : 0,
"ok" : 0
},
"limitState" : {
"alarm" : 0,
"noLimitProfile" : 0,
"ok" : 0,
"suspended" : 0,
"warning" : 0
},
"simState" : {
"activated" : 0,
"delivered" : 0,
"others" : 0,
"terminated" : 0,
"totalSims" : 0
}
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimStatesResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM States",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/actions" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves a list of all actions of a specific customer, with a default of 10 entries per page.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Status: The provided status is invalid.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 100.
\r\n - Date: Invalid parameter names for a date time filter.
\r\n - Date: dateTo is smaller than dateFrom.
\r\n - Date: Incorrect date and time formats.
\r\n
\r\n
\r\n Optional search parameters
\r\n
\r\n Supported search fields\r\n
\r\n \r\n - status – available values:\r\n
\r\n - open
\r\n - done
\r\n - rejected
\r\n
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "getActionDetails",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "Specify the status of the actions to specific customer. Use ':' to specify status' value.",
"example" : "search=status:open",
"in" : "query",
"name" : "search",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"description" : "The number of the specific page of listed action records to specific customer. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"minimum" : 1,
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned action list records to specific customer. Max. up to 100",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"maximum" : 100,
"minimum" : 1,
"type" : "integer",
"format" : "int64",
"default" : 10
}
}, {
"description" : "Start date of the search query. If not provided, dateTo minus 7 days will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-07T00:00:00.000Z",
"in" : "query",
"name" : "dateFrom",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
}, {
"description" : "End date of the search query. If not provided, current time will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-14T00:00:00.000Z",
"in" : "query",
"name" : "dateTo",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"actionListResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"actions" : [ {
"action" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"actionType" : "SIM_MODIFY",
"creationDate" : "2025-01-27T10:12:44.123Z",
"creator" : "string",
"signupId" : 0,
"source" : "Customer Portal",
"status" : "new"
}
} ],
"pageInfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
}
}
},
"schema" : {
"$ref" : "#/components/schemas/GetActionListResultParameters"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Action List",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/apiusage" : {
"get" : {
"deprecated" : true,
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the current counter value for the API usage of a specific customer.\r\n
\r\n \r\n - This call itself is NOT considered for the API usage counting.
\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimApiUsages",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimApiUsage" : {
"count" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimApiUsageResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get API Usage",
"tags" : [ "customers" ]
}
},
"/v1/partners/{partnerId}/pools" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves a list of all pools of the given partnerID. The data matches the content of the pool usage widget in the M2M Service Portal and retrieves the pool usage in MB.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n
\r\n \r\n\r\n",
"operationId" : "getCurrentPoolUsage",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"poolUsageResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"message" : "string",
"poolUsageList" : [ {
"poolUsage" : {
"monitoringPeriod" : 0,
"offering" : "string",
"offeringId" : 0,
"periodEndDate" : "string",
"periodStartDate" : "string",
"poolName" : "string",
"volumeConsumed" : 0,
"volumeInPool" : 0
}
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetCurrentPoolUsageResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get Current Pool Usage",
"tags" : [ "customers" ]
}
},
"/v1/partners/{partnerId}/sims" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves all SIM cards of a specific customer, with a default of 1000 entries per page. Only the ICCID will be shown, additional fields can be requested.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n
\r\n
\r\n Supported additional fields
\r\n Additional fields can simply be combined by semicolon \";\"
\r\n
\r\n Example: additionalfields=imsi;imei;status;field1;field2;msisdn;ipaddress
\r\n
\r\n Supported additional fields\r\n \r\n - euiccid
\r\n - imsi
\r\n - imei
\r\n - msisdn
\r\n - status (refering to logical sim status)
\r\n - ipaddressconfig
\r\n - field1
\r\n - field2
\r\n - field3
\r\n - field4
\r\n - field5
\r\n - field6
\r\n - field7
\r\n - field8
\r\n - field9
\r\n - field10
\r\n - simaggregateddata
\r\n
\r\n
\r\n Optional search parameters
\r\n The pattern for every search parameter: \"fieldname:value\". Additional fields can simply be combined by semicolon \";\"
\r\n
\r\n Example: search=field1:dadadada;status:Deleted;changedatefrom:2010-03-28T00:00:00.000Z
\r\n
\r\n Supported search fields\r\n \r\n - iccid
\r\n - status – available values:\r\n
\r\n - Ordered
\r\n - On Stock
\r\n - Delivered
\r\n - Test
\r\n - Productive
\r\n - Blocked (automatically)
\r\n - Blocked (manually)
\r\n - Suspended
\r\n - Terminated
\r\n - Deleted
\r\n - Undefined
\r\n - Ordered for stock
\r\n - Special Terminated
\r\n - Blocked (MNO)
\r\n
\r\n
\r\n - fraudstatus – available values:\r\n \r\n
\r\n - limitstatus – available values:\r\n
\r\n - OK
\r\n - Warning
\r\n - Alarm
\r\n - Suspended
\r\n
\r\n
\r\n - field1
\r\n - field2
\r\n - field3
\r\n - field4
\r\n - field5
\r\n - field6
\r\n - field7
\r\n - field8
\r\n - field9
\r\n - field10
\r\n
\r\n - changedatefrom
\r\n - changedateto
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimDetails",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "The number of the specific page of listed SIMs to specific customer. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned SIMs to specific customer. Max. up to 10000",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"maximum" : 10000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 1000
}
}, {
"description" : "Specify the conditions of the SIMs to specific customer. Use ':' to specify conditional value and ';' to combine multiple fields.\r\n All timestamps must have a Z at the end to mark them as UTC. e.g. 2022-07-14T00:00:00.000Z",
"example" : "search=status:Deleted;field1:dadadada",
"in" : "query",
"name" : "search",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"description" : "Specify what additional data to return within SIMs to specific customer. Use ';' to combine multiple fields.",
"example" : "additionalfields=imsi;imei;status",
"in" : "query",
"name" : "additionalfields",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"simListResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"pageInfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"sims" : [ {
"sim" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"euiccid" : "string",
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"iccid" : "string",
"imei" : "string",
"imsi" : "string",
"ipAddressConfig" : [ {
"apnName" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"ipAddressType" : "IPv4"
} ]
} ],
"msisdn" : "string",
"simAggregatedData" : {
"consumption" : 0,
"unit" : "KB"
},
"status" : "Productive"
}
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimListResultParameters"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get all SIMs of Customer",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/activation" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call starts the activation process for one or more SIM cards.\r\n
\r\n
\r\n You find the corresponding profile IDs required for parameterization in your customer portal GUI (mainly in the menu section settings). The offering ID can be found in your partner data section under My Products.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Additional Usage/Session Limit: Invalid usage unit provided.
\r\n - Additional Usage/Session Limit: Values must be zero or positive.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Profile: Could not find any data access profile in a valid status.
\r\n - Profile: Could not find any fraud profile in a valid status.
\r\n - Profile: Could not find any limit profile in a valid status.
\r\n - Profile: Could not find any network profile in a valid status.
\r\n - Profile: Could not find any cost limit profile in a valid status.
\r\n - Offering: Offering is restricted for this SIM action.
\r\n - IP addresses: Some submitted IP-Addresses are already taken.
\r\n
\r\n \r\n\r\n",
"operationId" : "activateSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"activationTemplateId" : 0,
"euiccidParameters" : [ {
"euiccid" : "string",
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"iccidParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"iccid" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"imeiParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"imei" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"imsiParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"imsi" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"offeringId" : 0,
"optionIds" : [ 0 ],
"profileDataParameters" : {
"accessProfileId" : 0,
"barringProfileId" : 0,
"costLimitProfileId" : 0,
"fraudProfileId" : 0,
"limitProfileId" : 0
},
"startDtRequested" : "2025-01-23T15:45:47.797Z",
"useTestTariff" : true
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body contains the minimum data required to activate a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
}, {
"iccid" : "8999829698799917214"
}, {
"iccid" : "8999829698799917215"
} ],
"offeringId" : 0,
"profileDataParameters" : {
"accessProfileId" : 0
},
"useTestTariff" : false
}
},
"1.3 : Activation with additional values" : {
"description" : "Request body contains some additional information for the SIM activation.",
"value" : {
"iccidParameters" : [ {
"field1" : "TestField1",
"iccid" : "998296987749503",
"staticIpsPerApnList" : [ {
"apnName" : "testApnName",
"ipv4AddressList" : [ "testipv4" ],
"ipv6AddressList" : [ "testipv6" ]
} ]
} ],
"offeringId" : 0,
"optionIds" : [ 0 ],
"profileDataParameters" : {
"accessProfileId" : 0,
"barringProfileId" : 0,
"costLimitProfileId" : 0,
"fraudProfileId" : 0,
"limitProfileId" : 0
},
"startDtRequested" : "2022-08-31T02:23:14.902Z",
"useTestTariff" : true
}
},
"1.4 : Activation using activation template" : {
"description" : "Request body when activating a SIM via activation template.",
"value" : {
"activationTemplateId" : 755338873,
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
}, {
"iccid" : "8999829698799917214"
}, {
"iccid" : "8999829698799917215"
} ],
"useTestTariff" : false
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimActivationParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Activation",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/block" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call blocks one or more SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Test tariff: SIM(s) cannot be blocked while in test.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "blockSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a SIM Block action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimBlockParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Block",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/euiccidbinding" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call binds new eUICCIDs (eIDs) to specific SIM cards.\r\n
\r\n
\r\n Note: If the "newEuiccid" field is set to "unbind" or an empty string "", the current eUICCID will be unassigned without a new eUICCID.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "bindEID",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string",
"newEuiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string",
"newEuiccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string",
"newEuiccid" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string",
"newEuiccid" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string",
"newEuiccid" : "string"
} ]
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a Bind eUICCID action for multiple SIM cards using ICCIDs as identifier. If the \"newEuiccid\" field is set to \"unbind\" or an empty string the current eUICCID will be unassigned.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503",
"newEuiccid" : "22233356789100000"
}, {
"iccid" : "998296987749504",
"newEuiccid" : "22233356789100001"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/BindEIDParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Bind eUICCID",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/fraudreset" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call resets the fraud status of specific SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: One or more SIM cards are automatically blocked.
\r\n - Fraud state: One or more SIM cards do not have a fraud state which could be reset.
\r\n - Fraud profile: SIM cards have different fraud profiles assigned.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "resetFraudStatus",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Multiple ICCIDs" : {
"description" : "Request body to start a Reset Fraud Status action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimResetFraudStatusParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Reset Fraud Status",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/limitoverride" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call overrides (temporarily deactivates) the current limit status of specific SIM cards with a limit profile.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "simOverrideLimitStatus",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Multiple ICCIDs" : {
"description" : "Request body to start an Override Limit Status action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimOverrideLimitStatusParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupIds" : [ 0 ],
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/MultipleSignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Override Limit Status",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/limitreset" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call resets the limit status of specific SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: One or more SIM cards are automatically blocked.
\r\n - Restriction status: One or more SIM(s) are in invalid restricted state. Valid states are None (0), Data Restricted (2)
\r\n - Limit state: One or more SIM cards do not have a limit state which could be reset.
\r\n - Limit profile: SIM cards have different limit profiles assigned.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "resetLimitStatus",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Multiple ICCIDs" : {
"description" : "Request body to start a Reset Limit Status action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimResetLimitStatusParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Reset Limit Status",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/limitrestore" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call restores the limit status of specific SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid SIM or SIM service state.
\r\n - SIM limit suspension: SIM(s) do not have their limit suspended.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Read only: REST API user is set to read-only
\r\n
\r\n \r\n\r\n",
"operationId" : "simRestoreLimitStatus",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Multiple ICCIDs" : {
"description" : "Request body to start a Restore Limit Status action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimRestoreLimitStatusParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupIds" : [ 0 ],
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/MultipleSignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Restore Limit Status",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/optionbooking" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call books new options to the given SIMs.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - SIM status: SIM(s) have no service.
\r\n - SIM status: SIM(s) with test tariff.
\r\n - SIM status: SIM(s) with suspended tariff.
\r\n - SIM offering: SIMs with different offerings.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Option(s) to book: Option(s) to book must be provided.
\r\n - Option(s) to book: Option offering invalid.
\r\n - Option(s) to book: Only one option of the same basic product may be chosen.
\r\n - Option(s) to book: An IP Based Billing option must not be added to a non Classic SIM.
\r\n - Option(s) to book: Virtual SIM card and new option is not an eSIM option.
\r\n - Option(s) to book: Not a virtual SIM card and new option is an eSIM option.
\r\n - Option(s) to book: Cross zone conflict between options.
\r\n
\r\n \r\n\r\n",
"operationId" : "bookOption",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"optionsToAdd" : [ 0 ]
}
},
"1.2 : Simple request" : {
"description" : "Request body contains the minimum data required to book an option to a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "89490200001049625828"
} ],
"optionsToAdd" : [ 800007128, 800007129 ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimOptionBookingParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Book Option",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/optionchange" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call exchanges one option with another one of the same type.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - SIM status: SIM(s) have no service.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Option to terminate: Option to terminate must be provided.
\r\n - Option to terminate: Option offering invalid.
\r\n - Option to terminate: Virtual SIM card, eSIM option missing.
\r\n - Option to add: Option to add must be provided.
\r\n - Option to add: Option offering invalid.
\r\n - Option to add: Virtual SIM card and new option is not an eSIM option.
\r\n - Option to add: Not a virtual SIM card and new option is an eSIM option.
\r\n - Option to add: Cross zone conflict between options.
\r\n - Option to add/terminate: Option to terminate and option to add must not be the same.
\r\n - Option to add/terminate: Mixing two types of option groups is not allowed.
\r\n
\r\n \r\n\r\n",
"operationId" : "changeOption",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"optionToTerminate" : 0,
"optionToAdd" : 0
}
},
"1.2 : Simple request" : {
"description" : "Request body contains the minimum data required to change an option of a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "89490200001049625828"
} ],
"optionToTerminate" : 800007128,
"optionToAdd" : 800007129
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimOptionChangeParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Change Option",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/optiontermination" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call removes one option for one or more SIM cards..\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - SIM status: SIM(s) have no service.
\r\n - SIM status: SIM(s) with test tariff.
\r\n - SIM status: SIM(s) with suspended tariff.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Read only: REST API user is set to read-only.
\r\n - Option(s) to terminate: Option to terminate must be provided.
\r\n - Option(s) to terminate: eSIM option can not be terminated.
\r\n - Option(s) to terminate: Selected options may not be terminated at this time.
\r\n
\r\n \r\n\r\n",
"operationId" : "terminateOption",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"optionsToTerminate" : [ 800007128 ]
}
},
"2: Simple Option Termination" : {
"description" : "Request body contains the minimum data required to terminate an option of a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "89490200001049625828"
} ],
"optionsToTerminate" : [ 800007128 ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimOptionTerminationParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Terminate Option",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/order" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call starts the order process for new SIM cards of a specific SIM material.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Shipping address: Given email address is not valid.
\r\n - SIM material: SIM type status is not active.
\r\n - SIM material: SIM type is not related to the customer.
\r\n - SIM material: Customer is not allowed to own virtual SIMs.
\r\n - Order quantity: Amount of SIM cards must be a multiple of the package size.
\r\n - Order quantity: Ordered amount of SIM cards undercuts the minimum order quantity.
\r\n - Order quantity: Monthly quantity of max allowed number of SIM orders has been exceeded.
\r\n - Order quantity: Insufficient number of SIM cards on stock.
\r\n - Delivery date: Desired delivery date has to be after the minimal delivery time.
\r\n - Delivery date: Preferred delivery date is a holiday.
\r\n - Delivery date: Preferred delivery date must not be on a weekend.
\r\n - Delivery date: Desired delivery date has to be after the minimum delivery time.
\r\n
\r\n\r\n\r\n",
"operationId" : "simOrder",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema" : {
"description" : "Sim Order schema with all values that are supported.",
"value" : {
"note" : "Please send to 2nd floor directly",
"notificationEmailAddress" : "john.dao@xzeus.com",
"numberOfSims" : 10,
"overrideMoq" : true,
"shippingAddress" : {
"additionToAddress1" : "Ally 160",
"additionToAddress2" : "Lane 3",
"additionalInformation" : "thanks",
"attention" : "John Dao",
"city" : "Taipei",
"companyName" : "XZeus",
"country" : "Taiwan",
"firstName" : "John",
"houseNumber" : "5978",
"lastName" : "Dao",
"postalCode" : "987",
"salutation" : "Mr.",
"street" : "FuXing"
},
"simType" : "Basic_2FF_Test",
"startDtRequested" : "2025-01-23T16:07:15.848Z"
}
},
"1.2 : Simple request (only mandatory values)" : {
"description" : "Request body to start a SIM Order action using only mandatory values.",
"value" : {
"simType" : "Basic_2FF_Test",
"numberOfSims" : 10,
"startDtRequested" : "2025-01-23T16:07:15.848Z",
"shippingAddress" : {
"companyName" : "XZeus",
"firstName" : "John",
"lastName" : "Dao",
"salutation" : "Mr.",
"street" : "FuXing",
"houseNumber" : "5978",
"postalCode" : "987",
"city" : "Taipei",
"country" : "Taiwan"
}
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimOrderParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Order",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/productivestate" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call sets one or more SIM cards to productive state.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid SIM or SIM service state. Valid status (techn.) is active (1). Valid status (comm.) is active (1).
\r\n - SIM status: Service connected to one or more SIM cards is not a test tariffs.
\r\n - Open workflow: There is an open 80059 - Set SIM to productive for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "enterProductiveState",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Multiple ICCIDs" : {
"description" : "Request body to start an Enter Productive State action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimEnterPrdouctiveStateParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Enter Productive State",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/profiles" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call adds, changes or deletes different types of profiles on specific SIM cards.\r\n
\r\n
\r\n You find the corresponding profile IDs required for parameterization in your customer portal GUI (mainly in the menu section settings). Use \"delete\" instead of a profile ID to remove a profile from SIM cards.\r\n
\r\n
\r\n If profiles are not part of the body or set to noChange, the profile will not change.\r\n
\r\n If profiles are set to delete, the profile will be removed.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Profile: At least one profile must be set.
\r\n - Profile: Profile contains invalid profile id(s).
\r\n - Profile: Invalid limit profile id.
\r\n - Profile: Chosen APN is not assigned to the data access profile.
\r\n - IP address: IPv4/IPv6 address is not valid.
\r\n - IP address: Duplicate IP addresses.
\r\n - IP address: Submitted IP address is already taken.
\r\n - IP address: Invalid number of static IPs provided.
\r\n - IP address: Static IP assignment is not possible for an APN with dynamic IP assignment.
\r\n
\r\n \r\n\r\n",
"operationId" : "modifySimProfiles",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"iccidParameters" : [ {
"iccid" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"imeiParameters" : [ {
"imei" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"imsiParameters" : [ {
"imsi" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"msisdnParameters" : [ {
"msisdn" : "string",
"staticIpsPerApnList" : [ {
"apnName" : "string",
"ipv4AddressList" : [ "string" ],
"ipv6AddressList" : [ "string" ]
} ]
} ],
"profileParameters" : {
"accessProfileId" : "string",
"barringProfileId" : "string",
"costLimitProfileId" : "string",
"fraudProfileId" : "string",
"limitProfileId" : "string"
}
}
},
"1.2 : Simple request" : {
"description" : "Request body to start a SIM Modify Profiles action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"profileParameters" : {
"accessProfileId" : "755436629",
"limitProfileId" : "634630681"
}
}
},
"1.3 : Simple request with noChange" : {
"description" : "Access profile will be updated and all the other profiles remain unchanged.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"profileParameters" : {
"accessProfileId" : "755436629",
"limitProfileId" : "noChange"
}
}
},
"1.4 : Simple request with delete" : {
"description" : "Access profile will be updated. Cost limit profile and fraud profile are deleted. Barring profile and limit profile remain unchanged.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"profileParameters" : {
"accessProfileId" : "755436629",
"costLimitProfileId" : "delete",
"fraudProfileId" : "delete"
}
}
},
"1.5 : Request with additional parameter staticIpsPerApnList" : {
"description" : "Standard request body including some IP addresses.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999875305035641497",
"staticIpsPerApnList" : [ {
"apnName" : "Private_APN_01",
"ipv4AddressList" : [ "1.2.3.4" ]
} ]
} ],
"profileParameters" : {
"accessProfileId" : "749352761"
}
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimModifyProfilesParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Modify Profiles",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/remarks" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call modifies the remark fields for specific SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "simModifyRemarks",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string",
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string"
} ],
"iccidParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"iccid" : "string"
} ],
"imeiParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"imei" : "string"
} ],
"imsiParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request" : {
"description" : "Request body to start a SIM Modify Remarks action using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503",
"field1" : "TestRemark1"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimModifyRemarksParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Modify Remarks",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/restrict" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call restricts B2B data for selected SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid SIM or SIM service state. Valid status (techn.) is active (1). Valid status (comm.) is active (1).
\r\n - Open workflow: There is an open 80130 - Change SIM Restriction workflow (in restrict SIM mode) for the selected SIM(s).
\r\n - Customer: The customer is not allowed to trigger a SIM Restriction.
\r\n - Restriction status: One or more SIM(s) are in invalid restricted state. Valid states are None (0), Speed-Step-Down (1).
\r\n
\r\n \r\n\r\n",
"operationId" : "restrictSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a SIM Restrict action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimRestrictParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Restrict",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/simallocation" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call moves specific SIM cards from a customer (superunit) to a corresponding subunit and vice versa.\r\n
\r\n
\r\n Supported SIM states:\r\n \r\n - Delivered SIM cards (inactive SIMs - no service connected to the SIM).
- Activated SIM cards (service status is 1 (active) or 6 (deactivated).
\r\n
\r\n Point of time when SIM cards are being moved:\r\n \r\n - Instantly -> request contains delivered SIM cards only.
- Next day -> request contains activated SIM cards only. The target unit does not have a different account (super - and subunit share the invoice).
\r\n - Beginning of next month/next billing period -> request contains activated SIM cards only. The target unit has a different account (super - and subunit do not share the invoice).
\r\n
\r\n Note: in case of a mixed request (delivered + active SIM cards) the execution time is either at the beginning of the next month or on the next day, depending on whether the target unit has own invoicing or not.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Recipient: Recipient is not a valid target.
\r\n - Recipient: Recipient is terminated.
\r\n - Offering: Offering is not valid/blacklisted for the recipient.
\r\n - Option offering: One or more option offerings are not valid/blacklisted for the recipient.
\r\n - Data profile: One or more of the SIMs contain invalid data profiles for the recipient (APNs not allowed, profile not found or invalid customer).
\r\n
\r\n \r\n\r\n",
"operationId" : "moveSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"recipient" : 0
}
},
"1.2 : Simple request" : {
"description" : "Request body to start a SIM Move action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"recipient" : 500082
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimMoveParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Move",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/simtransfer" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves a list of all SIM transfers of a customer.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n - No SIM Transfer found for the given customer.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimTransferList",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "The number of the specific page of listed transfers to specific customer. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned transfers to specific customer. Max. up to 10000",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"maximum" : 10000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 20
}
}, {
"description" : "Specify the status of the transfers to specific customer",
"example" : "search=ACTIVE",
"in" : "query",
"name" : "search",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimTransferList" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"info" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"simTransferList" : [ {
"sim_transfer" : {
"completionDate" : "string",
"error" : "string",
"id" : 0,
"linkToDetail" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"numberOfSims" : 0,
"partnerA" : "string",
"partnerB" : "string",
"startDate" : "string",
"status" : "completed"
}
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimTransferListResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Transfer List",
"tags" : [ "sim-transfer" ]
},
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call starts the transfer process of SIM cards from one customer to another.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Partner ID: User is assigned to Subunit.
\r\n - Partner ID: No PLS booked for customer with partner ID.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Recipient: Invalid recipient partner ID.
\r\n - Recipient: No recipient provided.
\r\n - Recipient: No valid relation exists between sender partner ID and recipient.
\r\n - notePartnerA: Contents of a note exceed the max allowed characters.
\r\n - transferRemark: Invalid transfer remark, the allowed value is a boolean.
\r\n
\r\n \r\n\r\n",
"operationId" : "createSimTransfer",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema" : {
"description" : "Create SIM Transfer schema with all values that are supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"notePartnerA" : "string",
"recipient" : "string",
"transferRemark01" : true,
"transferRemark02" : true,
"transferRemark03" : true,
"transferRemark04" : true,
"transferRemark05" : true,
"transferRemark06" : true,
"transferRemark07" : true,
"transferRemark08" : true,
"transferRemark09" : true,
"transferRemark10" : true
}
},
"2: Simple request" : {
"description" : "Request body contains the minimum data required to start a SIM Transfer action.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
} ],
"recipient" : "500384"
}
},
"3: Request with additional values" : {
"description" : "Request body contains some additional information for the SIM Transfer.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
} ],
"recipient" : "500384",
"notePartnerA" : "transfer this SIM card",
"transferRemark01" : true
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimTransferCreationParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"successMessage" : "string",
"transactionId" : 0
},
"schema" : {
"$ref" : "#/components/schemas/SimTransferCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Create SIM Transfer",
"tags" : [ "sim-transfer" ]
}
},
"/v1/partners/{partnerId}/sims/actions/simtransfer/{transactionId}" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the details of a SIM transfer.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimTransferDetails",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "Transaction ID of the specific transfer",
"example" : 1001092333,
"in" : "path",
"name" : "transactionId",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"description" : "The number of the specific page of listed SIMs involved in specific SIM transfer. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned SIMs involved in specific SIM transfer. Max. up to 10000",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"maximum" : 10000,
"minimum" : 1,
"type" : "integer",
"format" : "int32",
"default" : 1000
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimTransferDetails" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"completionDate" : "string",
"error" : "No",
"id" : 0,
"notePartnerA" : "string",
"notePartnerB" : "string",
"pageInfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"partnerA" : "string",
"partnerB" : "string",
"selectedFields" : {
"field1" : "NO",
"field10" : "NO",
"field2" : "NO",
"field3" : "NO",
"field4" : "NO",
"field5" : "NO",
"field6" : "NO",
"field7" : "NO",
"field8" : "NO",
"field9" : "NO"
},
"simTransfer" : {
"amountError" : 0,
"amountOverall" : 0,
"amountStillPending" : 0,
"amountSuccess" : 0,
"sims" : [ {
"sim" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"iccid" : "string"
}
} ]
},
"startDate" : "string",
"status" : "approved",
"subunitPartnerID" : "string"
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimTransferDetailResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Transfer Details",
"tags" : [ "sim-transfer" ]
},
"patch" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call updates an open SIM transfer – to 'abort' (as sender), or 'accept'/'reject' (as receiver) the transfer.\r\n
\r\n
\r\n You find the corresponding profile IDs required for parameterization in your customer portal GUI (mainly in the menu section settings). The offering ID can be found in your partner data section under My Products.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Partner ID: User is assigned to Subunit.
\r\n - Partner ID: No PLS booked for customer with partner ID.
\r\n - Transaction ID: Could not find any transactions with the provided ID.
\r\n - Transaction ID: No active transaction found.
\r\n - Transaction ID: The customer does not match the provided transaction.
\r\n - Action: The provided action is invalid.
\r\n - Action: Sending partner can only 'abort' the transaction.
\r\n - Action: Receiving partner can only 'accept' or 'reject' the transaction.
\r\n - Action: When choosing the action 'abort', it is not required to add any notes.
\r\n - Action: When choosing the action 'abort', it is not required to set any SIM related properties.
\r\n - Action: When choosing the action 'reject', it is not required to set any SIM related properties.
\r\n - SIM parameters: The provided SIM cards are in status DELIVERED and no additional SIM parameters are allowed (offering, options, profiles, activation template).
\r\n - Activation template: Activation template with ID does not exist.
\r\n - Offering: Offering is required to transfer active SIMs.
\r\n - Offering: Offering is restricted for this SIM action.
\r\n - Profile: Could not find any data access profile in a valid status.
\r\n - Profile: Data access profile must be provided for non SCS offerings.
\r\n - Profile: Could not find any fraud profile in a valid status.
\r\n - Profile: Could not find any limit profile in a valid status.
\r\n - Profile: Could not find any network profile in a valid status.
\r\n - Profile: Could not find any cost limit profile in a valid status.
\r\n - Note: Contents of a note exceed the max. allowed characters.
\r\n - Remark: Contents of a remark exceed the max. allowed characters.
\r\n - TransferRemark: When accepting the transaction with transferring the remark field, it is not allowed to specify the same remark field in the payload.
\r\n - TransferRemark: Remark field cannot be transferred if it has not been marked for transfer by the sending partner.
\r\n - Subunit: Subunit does not belong to super unit.
\r\n - Subunit: Subunit is the super unit.
\r\n - Subunit: Subunit not active.
\r\n - Subunit: Offering is blacklisted for subunit.
\r\n - Subunit: Option offerings are blacklisted for subunit.
\r\n - Subunit: Data access profile not valid for subunit (APNs not allowed).
\r\n
\r\n \r\n\r\n",
"operationId" : "updateSimTransfer",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "Transaction ID of the specific transfer",
"example" : 1001092333,
"in" : "path",
"name" : "transactionId",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema" : {
"description" : "Update SIM Transfer schema with all values that are supported.",
"value" : {
"action" : "accept",
"activationTemplateId" : 0,
"note" : "string",
"offeringId" : 0,
"optionIds" : [ 0 ],
"profileDataParameters" : {
"accessProfileId" : 0,
"barringProfileId" : 0,
"costLimitProfileId" : 0,
"fraudProfileId" : 0,
"limitProfileId" : 0
},
"remark01" : "string",
"remark02" : "string",
"remark03" : "string",
"remark04" : "string",
"remark05" : "string",
"remark06" : "string",
"remark07" : "string",
"remark08" : "string",
"remark09" : "string",
"remark10" : "string",
"transferRemark01" : true,
"transferRemark02" : true,
"transferRemark03" : true,
"transferRemark04" : true,
"transferRemark05" : true,
"transferRemark06" : true,
"transferRemark07" : true,
"transferRemark08" : true,
"transferRemark09" : true,
"transferRemark10" : true,
"subunitPartnerID" : "string"
}
},
"2: Abort SIM Transfer" : {
"description" : "Sender aborts the SIM Transfer.",
"value" : {
"action" : "abort"
}
},
"3.1: Accept SIM Transfer for delivered SIMs" : {
"description" : "Receiver accepts the SIM Transfer for delivered SIMs.",
"value" : {
"action" : "accept"
}
},
"3.2: Accept SIM Transfer for active SIMs" : {
"description" : "Receiver accepts the SIM Transfer for active SIMs.",
"value" : {
"action" : "accept",
"offeringId" : 800007129,
"profileDataParameters" : {
"accessProfileId" : 755767116
}
}
},
"3.3: Accept SIM Transfer for active SIMs using activation template" : {
"description" : "Receiver accepts the SIM Transfer for active SIMs using an activation template.Activation template provides offering, options, profiles and remarks fields. Remark fields can still be transferred from sending partner if they have been marked to be transferred by the sending partner.In this example remark 1 is transferred from sending partner. Remarks 2-10 are taken from the activation template.",
"value" : {
"action" : "accept",
"activationTemplateId" : 706608003,
"note" : "This uses an activation template which provides offering, options, profiles and remarks and transfers remark 1 from sending partner. Remarks 2-10 are taken from the activation template.",
"transferRemark01" : true
}
},
"3.4: Accept SIM Transfer for active SIMs with remarks" : {
"description" : "Receiver accepts the SIM Transfer for active SIMs, transfers remark 1 from sending partner and sets remark 8 and 9.",
"value" : {
"action" : "accept",
"offeringId" : 800007129,
"profileDataParameters" : {
"accessProfileId" : 756757135
},
"note" : "This transfers remark 1 from sending partner and sets remark 8 and 9.",
"transferRemark01" : true,
"remark08" : "This is remark field 8 content.",
"remark09" : "This is remark field 9 content."
}
},
"3.5: Accept SIM Transfer for active SIMs for a subunit" : {
"description" : "Receiver accepts the SIM Transfer for active SIMs and transfers them to a subunit.",
"value" : {
"action" : "accept",
"offeringId" : 800007129,
"optionIds" : [ 800007126, 800007127, 800007128 ],
"profileDataParameters" : {
"accessProfileId" : 755767116
},
"note" : "This is a transfer to my subunit.",
"subunitPartnerID" : "501520"
}
},
"4: Reject SIM Transfer (receiver)" : {
"description" : "Reject the SIM Transfer.",
"value" : {
"action" : "reject"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimTransferUpdateParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"UpdateSimTransfer" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"successMessage" : "string"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdateSimTransferResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Update SIM Transfer",
"tags" : [ "sim-transfer" ]
}
},
"/v1/partners/{partnerId}/sims/actions/suspension" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call suspends the current tariff of specific SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "suspendSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a SIM Suspend action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimSuspendParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Suspend",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/tariffchange" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call changes the active tariff and options for one or more SIM cards.\r\n
\r\n
\r\n You find the corresponding profile IDs required for parameterization in your customer portal GUI (mainly in the menu section settings). The offering ID can be found in your partner data section under My Products.\r\n
\r\n
\r\n Upgrade feature
\r\n Precondition: All SIMs in the request have the same tariff assigned.\r\n
\r\n Enables tariff upgrade without consideration of the binding period.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Additional Usage/Session Limit: Invalid usage unit provided.
\r\n - Additional Usage/Session Limit: Values must be zero or positive.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Date: Incorrect date and time formats.
\r\n - OfferingId: Invalid offering ID.
\r\n - Offering: Offering is restricted for this SIM action.
\r\n - OptionId: Invalid option ID.
\r\n
\r\n \r\n\r\n",
"operationId" : "tariffChange",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"offeringId" : 0,
"optionIds" : [ 0 ],
"startDtRequested" : "2025-01-24T10:50:29.388Z"
}
},
"1.2 : Simple request" : {
"description" : "Request body contains the minimum data required to change the tariff of a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"offeringId" : 800008266
}
},
"1.3 : Change Tariff with additional values" : {
"description" : "Request body contains some additional information for changing the tariff of a SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ],
"offeringId" : 800008266,
"optionIds" : [ 800006825, 800006833, 800006829 ],
"startDtRequested" : "2032-03-24T12:45:49.538Z"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimChangeTariffParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Change Tariff",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/termination" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call terminates active SIM cards.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "terminateSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported. Default value for specialTermination is false.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"specialTermination" : false
}
},
"1.2 : Termination" : {
"description" : "Request body to start a SIM Termination action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ]
}
},
"1.3 : Special Termination" : {
"description" : "Request body to start a SIM Special Termination action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"specialTermination" : true,
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimTerminationParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Termination",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/unblock" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call unblocks specific SIM cards and sets them active again.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Additional Usage/Session Limit: Invalid usage unit provided.
\r\n - Additional Usage/Session Limit: Values must be zero or positive.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n - Requested operation not allowed for suspended SIM cards.
\r\n
\r\n\r\n\r\n",
"operationId" : "unblockSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"additionalSessionLimit" : 10,
"additionalUsageLimitValue" : 100,
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"unit" : "MB"
}
},
"1.2 : Simple request" : {
"description" : "Request body contains the minimum data required to start an Unblock SIM action.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
},
"1.3 : Unblock SIM with limit values" : {
"description" : "Request body contains some additional limit information such as session limit and usage limit.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ],
"additionalSessionLimit" : 10,
"additionalUsageLimitValue" : 100,
"unit" : "MB"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimUnblockParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Unblock",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/unrestrict" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call unrestricts (allows) B2B data for selected SIM cards.\r\n
\r\n
\r\n Unrestriction for APN specific limit profiles
\r\n Only supports single SIM and requires additional APN and limit profile zone data in the payload.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid SIM or SIM service state. Valid status (techn.) is active (1). Valid status (comm.) is active (1).
\r\n - Open workflow: There is an open 80130 - Change SIM Restriction workflow (in unrestrict SIM mode) for the selected SIM(s).
\r\n - Customer: The customer is not allowed to trigger a SIM Unrestriction.
\r\n - Restriction status: One or more SIM(s) are in invalid restricted state. Valid states are Speed-Step-Down (1), DR (2).
\r\n - APN specific: APN data is in payload for a request containing more than 1 SIM identifier.
\r\n - APN specific: Payload contains duplicate APN names.
\r\n - APN specific: Payload contains duplicate limit profile zone names within one APN.
\r\n - APN specific: One or more of the provided APNs or limit profile zones are not related to the SIM.
\r\n - APN specific: additionalVolume provided without additionalVolumeUnit.
\r\n
\r\n \r\n\r\n",
"operationId" : "unrestrictSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : SIM unrestriction - Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : SIM unrestriction - Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a SIM Unrestrict action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
},
"2.1 : APN unrestriction - Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported. Only possible for single SIM.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"apnsToUnrestrict" : [ {
"apnName" : "string",
"limitProfileZone" : [ {
"zoneName" : "string",
"additionalVolume" : 0,
"additionalVolumeUnit" : "B",
"additionalSessions" : 0
} ]
} ]
}
},
"2.2 : APN unrestriction - Simple request" : {
"description" : "Request body to start a SIM Unrestrict action for a specific APN.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799918072"
} ],
"apnsToUnrestrict" : [ {
"apnName" : "internet.testapn.de",
"limitProfileZone" : [ {
"zoneName" : "Test.Zone 1",
"additionalVolume" : 100,
"additionalVolumeUnit" : "MB",
"additionalSessions" : 5
} ]
} ]
}
},
"2.3 : APN unrestriction - Multiple APNs and limit profile zones" : {
"description" : "Request body to start a SIM Unrestrict action for multiple APNs and limit profile zones.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799918072"
} ],
"apnsToUnrestrict" : [ {
"apnName" : "internet.testapn.de",
"limitProfileZone" : [ {
"zoneName" : "Test.Zone 1",
"additionalVolume" : 100,
"additionalVolumeUnit" : "MB",
"additionalSessions" : 5
} ]
}, {
"apnName" : "public.wireless.testcompany.de",
"limitProfileZone" : [ {
"zoneName" : "Company.Zone 1",
"additionalVolume" : 800,
"additionalVolumeUnit" : "KB",
"additionalSessions" : 2
}, {
"zoneName" : "Company.Zone 2",
"additionalSessions" : 10
}, {
"zoneName" : "Company.Zone 3",
"additionalVolume" : 1,
"additionalVolumeUnit" : "GB"
} ]
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimUnrestrictParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Unrestrict",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/unsuspension" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call unsuspends specific SIM cards and sets their normal tariff to active again.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: No identifier provided.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Mixed identifiers e.a. ICCID and IMSI in one request.
\r\n - SIM identifier: Number of identifiers exceeds the configured max. value.
\r\n - SIM identifier: SIM(s) do not exist for given identifier(s).
\r\n - SIM identifier: SIM(s) for given identifier(s) do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Open workflow: There is an open workflow for the selected SIM(s).
\r\n
\r\n \r\n\r\n",
"operationId" : "unsuspendSim",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (multiple ICCIDs)" : {
"description" : "Request body to start a SIM Unsuspend action for multiple SIM cards using ICCIDs as identifier.",
"value" : {
"iccidParameters" : [ {
"iccid" : "998296987749503"
}, {
"iccid" : "998296987749504"
}, {
"iccid" : "998296987749505"
}, {
"iccid" : "998296987749506"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimUnSuspendParameters"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Unsuspend",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/actions/{signupId}" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the current status of a specific action. If the action is cancellable, the result also contains a link to the corresponding cancel action.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Signup ID: User's partner ID has no access to requested SIM action.
\r\n - Signup ID: Invalid signup ID.
\r\n
\r\n \r\n\r\n",
"operationId" : "getActionStatus",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ID of the specific SIM action",
"example" : 704705602,
"in" : "path",
"name" : "signupId",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"actionStatus" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"affectedSims" : [ {
"iccid" : "string"
} ],
"createTime" : "string",
"creator" : "string",
"originalRequest" : "string",
"status" : "done"
}
},
"schema" : {
"$ref" : "#/components/schemas/ActionStatus"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Action Status",
"tags" : [ "sims" ]
},
"patch" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call cancels a specific open action for a SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - Signup ID: User's partner ID has no access to requested SIM action.
\r\n - Signup ID: Invalid signup ID.
\r\n - Workflow: Corresponding workflow doesn't exist.
\r\n - Workflow: Corresponding workflow doesn't support cancellation.
\r\n - Workflow: Corresponding workflow is already finished (done).
\r\n - Workflow: Point of no return has been passed. Process cannot be cancelled as of now.
\r\n
\r\n \r\n\r\n",
"operationId" : "cancel",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ID of the specific SIM action",
"example" : 704705602,
"in" : "path",
"name" : "signupId",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"Standard request" : {
"description" : "Request body with status value 'cancelled' is required to start the cancel action.",
"value" : {
"status" : "cancelled"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimCancelParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "SIM Action Cancellation",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves detail information of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - RefreshSession: Invalid refresh session value, must be a boolean.
\r\n
\r\n \r\n\r\n",
"operationId" : "postSimDetails",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (single ICCID)" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimDetailsParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimDetails" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"accessProfile" : "string",
"activationCode" : "string",
"barringProfile" : "string",
"bindingPeriod" : "string",
"bookedOptions" : [ {
"bindingPeriod" : "string",
"customerOffering" : "string",
"externalOfferingId" : 0
} ],
"busyState" : "0",
"costLimitProfile" : "string",
"eidProfileStatus" : "FREE",
"euiccid" : "string",
"externalOfferingId" : "string",
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"fraudProfile" : "string",
"fraudStatus" : "OK",
"iccid" : "string",
"imei" : "string",
"imsi" : "string",
"ipAddressConfig" : [ {
"apnName" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"ipAddressType" : "IPv4"
} ]
} ],
"limitProfile" : "string",
"limitStatus" : "OK",
"msisdn" : "string",
"offering" : "string",
"restrictionStatus" : "none",
"simAggregatedData" : {
"consumption" : 0,
"unit" : "KB"
},
"smsrid" : "string",
"status" : "Ordered"
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimDetailsResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Details [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/hlrcheck" : {
"post" : {
"deprecated" : true,
"description" : "\r\n\r\n \r\n Description
\r\n This method allows you to check the SIM status directly in the HLR. The request is asynchroneous. You can see the updated data with a call to simDetails.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: ICCID does not exist or does not belong to given partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - SIM status: SIM is not in a valid SIM or SIM service state. Valid status (techn.) is active (1), termination marked (7), tariff change marked (17), special termination marked (18), option change marked (20), IP based billing operations marked (22).
- SIM service function: checkSimInHlr is not supported for SIM card.
\r\n - HLR request frequency: Too frequent HLR requests.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "checkSimInHlr_1",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (single ICCID)" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimInHLRParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Check SIM in HLR [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/hlrreset" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This method allows you to reset the SIM card directly in the HLR. You can check the successful reset in the output of simDetails.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: ICCID does not exist or does not belong to given partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - SIM status: SIM is not in a valid SIM or SIM service state. Valid status (techn.) is active (1), termination marked (7), tariff change marked (17), special termination marked (18), option change marked (20), IP based billing operations marked (22).
- HLR request frequency: Too frequent HLR requests.
\r\n - Read only: REST API user is set to read-only.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "resetSimInHlr",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (single ICCID)" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/ResetSimInHLRParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Reset SIM in HLR [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/session" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the active session of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - RefreshSession: Invalid refresh session value, must be a boolean.
\r\n
\r\n \r\n\r\n",
"operationId" : "postSimSession",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"1.2 : Simple request (single ICCID)" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimSessionParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : SimSessionResult (schema)" : {
"description" : "Used for single sessions",
"value" : {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
}
},
"1.2 : SimSessionResult (with values)" : {
"description" : "Used for single sessions",
"value" : {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14048554,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:22:34.253Z",
"volumeUpload" : 5656,
"volumeDownload" : 15,
"volumeOverall" : 5671,
"volumeRounded" : 5671,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : "",
"_links" : {
"self" : {
"rel" : "self",
"href" : "http://localhost:8080/v1/partners/100017/sims/8999829698799918072/session?refreshSession=false¶llelSessions=false&identifierType=iccid",
"type" : "GET",
"name" : "get SIM session"
}
}
}
}
},
"2.1 : SimParallelSessionResult (schema)" : {
"description" : "Used for parallel sessions",
"value" : {
"SimParallelSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"sessions" : [ {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
} ]
}
}
},
"2.2 : SimParallelSessionResult (with values)" : {
"description" : "Used for parallel sessions",
"value" : {
"SimParallelSessionResult" : {
"sessions" : [ {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14049029,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:30:29.836Z",
"volumeUpload" : 5656,
"volumeDownload" : 15,
"volumeOverall" : 5671,
"volumeRounded" : 5671,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : ""
}
}, {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14049029,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:30:29.836Z",
"volumeUpload" : 5555,
"volumeDownload" : 12,
"volumeOverall" : 5567,
"volumeRounded" : 5567,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.redundant.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : ""
}
} ],
"_links" : {
"self" : {
"rel" : "self",
"href" : "http://localhost:8080/v1/partners/100017/sims/8999829698799918072/session?refreshSession=false¶llelSessions=true&identifierType=iccid",
"type" : "GET",
"name" : "get SIM session"
}
}
}
}
}
},
"schema" : {
"type" : "object",
"anyOf" : [ {
"$ref" : "#/components/schemas/GetSimSessionResult"
}, {
"$ref" : "#/components/schemas/GetSimParallelSessionResult"
} ],
"description" : "single session: GetSimSessionResult; parallel sessions: GetSimParallelSessionResult",
"example" : {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
}
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Session [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/sessionhistory" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the session history of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n - Date: Invalid parameter names for a date time filter.
\r\n - Date: dateTo is smaller than dateFrom.
\r\n - Date: Incorrect date and time formats.
\r\n
\r\n \r\n\r\n",
"operationId" : "postSimSessionHistory",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Single ICCID" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SimSessionHistoryParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimSessionHistoryResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"pageInfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"simSessionHistoryDetails" : [ {
"abortReason" : "1",
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipv4Address" : "string",
"ipv6AddressPrefix" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"rejectReason" : "The IMSI is not registered",
"restrictionReason" : "SIM restricted due to detected device fraud",
"startTime" : "string",
"stopTime" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeOverallRounded" : 0,
"volumeUpload" : 0
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimSessionHistoryResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Session History [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/sms" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n Send a message to the SIM card identified by the ICCID.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM does not exist for given ICCID.
\r\n - SIM identifier: SIM for given ICCID does not belong to the provided partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - SIM status: SIM is not in correct state for sending messages. SIM status (techn.) must be productive (1); Logical SIM status must be test (4) or productive (5).
\r\n - SIM function: SIM is restricted by a service function and cannot send messages.
\r\n - SMS content: Message is too long.
\r\n
\r\n \r\n\r\n",
"operationId" : "sendMessage_1",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ],
"message" : "This is a test SMS"
}
},
"1.2 : Simple request (single ICCID)" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ],
"message" : "This is a test SMS"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SendMessageWithIdentifierParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Send Message [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/sim/smshistory" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves a list of the SMS history for a SIM card within a specific time period.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM identifier: Duplicate identifiers provided.
\r\n - SIM identifier: Only one identifier is allowed.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n - Date: Invalid parameter names for a date time filter.
\r\n - Date: DateTo is smaller than dateFrom.
\r\n - Date: Incorrect date and time formats.
\r\n
\r\n \r\n\r\n",
"operationId" : "postSmsHistory",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1: Schema with all possible identifiers" : {
"description" : "Request body can only contain one of these identifiers. Mixing is not supported.",
"value" : {
"euiccidParameters" : [ {
"euiccid" : "string"
} ],
"iccidParameters" : [ {
"iccid" : "string"
} ],
"imeiParameters" : [ {
"imei" : "string"
} ],
"imsiParameters" : [ {
"imsi" : "string"
} ],
"msisdnParameters" : [ {
"msisdn" : "string"
} ]
}
},
"2: Single ICCID" : {
"description" : "Request body contains a single SIM.",
"value" : {
"iccidParameters" : [ {
"iccid" : "8999829698799917213"
} ]
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SmsHistoryParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SmsHistoryResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"pageinfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"smsHistoryData" : [ {
"callingMsisdn" : "string",
"diagSetFinal" : "string",
"internalState" : "string",
"lastEventTime" : "2025-01-27T11:38:28.391Z",
"origCalledMsisdn" : "string",
"retryCounter" : 0,
"sourceInterfaceType" : "string",
"submitTime" : "2025-01-27T11:38:28.391Z",
"targetInterfaceType" : "string",
"uid" : "string"
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSmsHistoryResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SMS History [multiple identifier support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves detail information of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - RefreshSession: Invalid refresh session value, must be a boolean.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimDetails_1",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimDetails" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"accessProfile" : "string",
"activationCode" : "string",
"barringProfile" : "string",
"bindingPeriod" : "string",
"bookedOptions" : [ {
"bindingPeriod" : "string",
"customerOffering" : "string",
"externalOfferingId" : 0
} ],
"busyState" : "0",
"costLimitProfile" : "string",
"eidProfileStatus" : "FREE",
"euiccid" : "string",
"externalOfferingId" : "string",
"field1" : "string",
"field10" : "string",
"field2" : "string",
"field3" : "string",
"field4" : "string",
"field5" : "string",
"field6" : "string",
"field7" : "string",
"field8" : "string",
"field9" : "string",
"fraudProfile" : "string",
"fraudStatus" : "OK",
"iccid" : "string",
"imei" : "string",
"imsi" : "string",
"ipAddressConfig" : [ {
"apnName" : "string",
"ipAddresses" : [ {
"ipAddress" : "string",
"ipAddressType" : "IPv4"
} ]
} ],
"limitProfile" : "string",
"limitStatus" : "OK",
"msisdn" : "string",
"offering" : "string",
"restrictionStatus" : "none",
"simAggregatedData" : {
"consumption" : 0,
"unit" : "KB"
},
"smsrid" : "string",
"status" : "Ordered"
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimDetailsResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Details [ICCID only support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}/hlrcheck" : {
"post" : {
"deprecated" : true,
"description" : "\r\n\r\n \r\n Description
\r\n This method allows you to check the SIM status directly in the HLR. The request is asynchroneous. You can see the updated data with a call to simDetails.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: ICCID does not exist or does not belong to given partner ID.
\r\n - SIM status: SIM is not in a valid SIM or SIM service state. Valid status (techn.) is active (1), termination marked (7), tariff change marked (17), special termination marked (18), option change marked (20), IP based billing operations marked (22).
- SIM service function: checkSimInHlr is not supported for SIM card.
\r\n - HLR request frequency: Too frequent HLR requests.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "checkSimInHlr",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Check SIM in HLR [ICCID only support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}/hlrreset" : {
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n This method allows you to reset the SIM card directly in the HLR. You can check the successful reset in the output of simDetails.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: ICCID does not exist or does not belong to given partner ID.
\r\n - SIM status: SIM is not in a valid SIM or SIM service state. Valid status (techn.) is active (1), termination marked (7), tariff change marked (17), special termination marked (18), option change marked (20), IP based billing operations marked (22).
- HLR request frequency: Too frequent HLR requests.
\r\n
\r\n
\r\n \r\n\r\n",
"operationId" : "ResetSimInHlr",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Reset SIM in HLR [ICCID only support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}/session" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the active session of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - RefreshSession: Invalid refresh session value, must be a boolean.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimSession",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "Optional parameter to specify if the session is refreshable. Default: false",
"example" : true,
"in" : "query",
"name" : "refreshSession",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
}, {
"description" : "Optional parameter to specify if the result considers parallel sessions. Default: false",
"example" : true,
"in" : "query",
"name" : "parallelSessions",
"required" : false,
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : SimSessionResult (schema)" : {
"description" : "Used for single sessions",
"value" : {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
}
},
"1.2 : SimSessionResult (with values)" : {
"description" : "Used for single sessions",
"value" : {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14048554,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:22:34.253Z",
"volumeUpload" : 5656,
"volumeDownload" : 15,
"volumeOverall" : 5671,
"volumeRounded" : 5671,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : "",
"_links" : {
"self" : {
"rel" : "self",
"href" : "http://localhost:8080/v1/partners/100017/sims/8999829698799918072/session?refreshSession=false¶llelSessions=false&identifierType=iccid",
"type" : "GET",
"name" : "get SIM session"
}
}
}
}
},
"2.1 : SimParallelSessionResult (schema)" : {
"description" : "Used for parallel sessions",
"value" : {
"SimParallelSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"sessions" : [ {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
} ]
}
}
},
"2.2 : SimParallelSessionResult (with values)" : {
"description" : "Used for parallel sessions",
"value" : {
"SimParallelSessionResult" : {
"sessions" : [ {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14049029,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:30:29.836Z",
"volumeUpload" : 5656,
"volumeDownload" : 15,
"volumeOverall" : 5671,
"volumeRounded" : 5671,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : ""
}
}, {
"SimSessionResult" : {
"iccid" : "8999829698799918072",
"imei" : "",
"country" : "",
"network" : "",
"sessionStart" : "2024-08-13T22:00:00.000Z",
"duration" : 14049029,
"ipAddress" : "10.0.0.1",
"lastUpdateTime" : "2025-01-23T13:30:29.836Z",
"volumeUpload" : 5555,
"volumeDownload" : 12,
"volumeOverall" : 5567,
"volumeRounded" : 5567,
"ipv6AddressPrefix" : "",
"apnAddress" : "internet.m2mportal.redundant.de",
"pdpType" : "IPv4",
"mcc" : "262",
"mnc" : "1",
"ratType" : "Classic M2M",
"restrictionReason" : ""
}
} ],
"_links" : {
"self" : {
"rel" : "self",
"href" : "http://localhost:8080/v1/partners/100017/sims/8999829698799918072/session?refreshSession=false¶llelSessions=true&identifierType=iccid",
"type" : "GET",
"name" : "get SIM session"
}
}
}
}
}
},
"schema" : {
"type" : "object",
"anyOf" : [ {
"$ref" : "#/components/schemas/GetSimSessionResult"
}, {
"$ref" : "#/components/schemas/GetSimParallelSessionResult"
} ],
"description" : "single session: GetSimSessionResult; parallel sessions: GetSimParallelSessionResult",
"example" : {
"SimSessionResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipAddress" : "string",
"ipv6AddressPrefix" : "string",
"lastUpdateTime" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"restrictionReason" : "SIM restricted due to detected device fraud",
"sessionStart" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeRounded" : 0,
"volumeUpload" : 0
}
}
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Session [ICCID only support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}/sessionhistory" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves the session history of a specific SIM card.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n - Date: Invalid parameter names for a date time filter.
\r\n - Date: dateTo is smaller than dateFrom.
\r\n - Date: Incorrect date and time formats.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSimSessionHistory",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "The number of the specific page of listed session history records to specific SIM. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"minimum" : 1,
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned session history records to specific SIM. Max. up to 50",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"maximum" : 50,
"minimum" : 1,
"type" : "integer",
"format" : "int64",
"default" : 10
}
}, {
"description" : "Start date of the search query. If not provided, dateTo minus 7 days will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-07T00:00:00.000Z",
"in" : "query",
"name" : "dateFrom",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
}, {
"description" : "End date of the search query. If not provided, current time will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-14T00:00:00.000Z",
"in" : "query",
"name" : "dateTo",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SimSessionHistoryResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"pageInfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"simSessionHistoryDetails" : [ {
"abortReason" : "1",
"apnAddress" : "string",
"country" : "string",
"duration" : 0,
"iccid" : "string",
"imei" : "string",
"ipv4Address" : "string",
"ipv6AddressPrefix" : "string",
"mcc" : "string",
"mnc" : "string",
"network" : "string",
"pdpType" : "IPv4",
"ratType" : "N/A",
"rejectReason" : "The IMSI is not registered",
"restrictionReason" : "SIM restricted due to detected device fraud",
"startTime" : "string",
"stopTime" : "string",
"volumeDownload" : 0,
"volumeOverall" : 0,
"volumeOverallRounded" : 0,
"volumeUpload" : 0
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSimSessionHistoryResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SIM Session History [ICCID only support]",
"tags" : [ "sims" ]
}
},
"/v1/partners/{partnerId}/sims/{iccid}/sms" : {
"get" : {
"description" : "\r\n\r\n \r\n Description
\r\n This call retrieves a list of the SMS history for a SIM card within a specific time period.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM(s) do not exist for given ICCID.
\r\n - SIM identifier: SIM(s) for given ICCID do not belong to the provided partner ID.
\r\n - SIM status: SIM(s) are currently being processed according to an earlier request (busy state).
\r\n - SIM status: SIM(s) are not in a valid state.
\r\n - Page: Input invalid page number.
\r\n - Page: Exceed the max allowed page number of 10000.
\r\n - Size: Input invalid size number.
\r\n - Size: Exceed the max allowed size number of 50.
\r\n - Date: Invalid parameter names for a date time filter.
\r\n - Date: DateTo is smaller than dateFrom.
\r\n - Date: Incorrect date and time formats.
\r\n
\r\n \r\n\r\n",
"operationId" : "getSmsHistory",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "The number of the specific page of listed SMS history records to specific SIM. Max. up to 10000",
"example" : 1,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"default" : 1
}
}, {
"description" : "The amount per page of returned SMS history records to specific SIM. Max. up to 50",
"example" : 10,
"in" : "query",
"name" : "size",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"default" : 20
}
}, {
"description" : "Start date of the search query. If not provided, dateTo minus 7 days will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-07T00:00:00.000Z",
"in" : "query",
"name" : "dateFrom",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
}, {
"description" : "End date of the search query. If not provided, current time will be used. All timestamps must have a Z at the end to mark them as UTC.",
"example" : "2022-07-14T00:00:00.000Z",
"in" : "query",
"name" : "dateTo",
"required" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
}
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"SmsHistoryResult" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"pageinfo" : {
"currentPage" : 0,
"nrOfPages" : 0,
"overallAmount" : 0,
"pageSize" : 0
},
"smsHistoryData" : [ {
"callingMsisdn" : "string",
"diagSetFinal" : "string",
"internalState" : "string",
"lastEventTime" : "2025-01-27T11:38:28.391Z",
"origCalledMsisdn" : "string",
"retryCounter" : 0,
"sourceInterfaceType" : "string",
"submitTime" : "2025-01-27T11:38:28.391Z",
"targetInterfaceType" : "string",
"uid" : "string"
} ]
}
},
"schema" : {
"$ref" : "#/components/schemas/GetSmsHistoryResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Get SMS History [ICCID only support]",
"tags" : [ "sims" ]
},
"post" : {
"description" : "\r\n\r\n \r\n Description
\r\n Send a message to the SIM card identified by the ICCID.\r\n
\r\n
\r\n Possible validation errors
\r\n \r\n - Service unavailable: Maintenance mode activated.
- Read only: REST API user is set to read-only.
\r\n - Request usage: Too Many Concurrent Requests on Platform.
\r\n - Partner ID: Invalid partner ID.
\r\n - Partner ID: User not authorized for this partner.
\r\n - SIM identifier: SIM does not exist for given ICCID.
\r\n - SIM identifier: SIM for given ICCID does not belong to the provided partner ID.
\r\n - SIM status: SIM is not in correct state for sending messages. SIM status (techn.) must be productive (1); Logical SIM status must be test (4) or productive (5).
\r\n - SIM function: SIM is restricted by a service function and cannot send messages.
\r\n - SMS content: Message is too long.
\r\n
\r\n \r\n\r\n",
"operationId" : "sendMessage",
"parameters" : [ {
"description" : "Partner ID of the customer",
"example" : "500379",
"in" : "path",
"name" : "partnerId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"description" : "ICCID value of the SIM",
"example" : "998296987749503",
"in" : "path",
"name" : "iccid",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"1.1 : Simple request" : {
"description" : "Request body contains the text message. Max. Byte length: 4000",
"value" : {
"message" : "This is a test SMS"
}
}
},
"schema" : {
"$ref" : "#/components/schemas/SendMessageParameter"
}
}
},
"description" : "Request body examples",
"required" : true
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"example" : {
"_links" : {
"additionalProp1" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp2" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
},
"additionalProp3" : {
"deprecation" : "string",
"href" : "string",
"hreflang" : "string",
"media" : "string",
"name" : "string",
"profile" : "string",
"rel" : "string",
"title" : "string",
"type" : "string"
}
},
"signupId" : 0,
"successMessage" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/SignUpCreationResult"
}
}
},
"description" : "Successful response"
},
"400" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "BAD_REQUEST",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Validation error. Refer to the list in the description."
},
"500" : {
"content" : {
"application/json" : {
"example" : {
"errors" : [ "string" ],
"message" : "string",
"status" : "INTERNAL_SERVER_ERROR",
"timestamp" : "string"
},
"schema" : {
"$ref" : "#/components/schemas/ApiError"
}
}
},
"description" : "Internal Server Error."
}
},
"summary" : "Send Message [ICCID only support]",
"tags" : [ "sims" ]
}
}
},
"components" : {
"schemas" : {
"Action" : {
"type" : "object",
"example" : null,
"properties" : {
"action" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "action"
},
"actionType" : {
"type" : "string",
"enum" : [ "ACTIVATE_POOL_LIMIT_PROFILE", "ACTIVATE_SIM", "ADD_OPTION", "BIND_EID_TO_SIM", "BLOCK_SIM", "BOOK_PLS_OPTION", "CANCEL_TERMINATE_SIM", "CHANGE_OPTION", "CHANGE_TARIFF", "CHECK_SIM_IN_HLR", "CREATE_BARRING_PROFILE", "CREATE_COST_LIMIT_PROFILE", "CREATE_DATA_ACCESS_PROFILE", "CREATE_FRAUD_PROFILE", "CREATE_LIMIT_PROFILE", "CREATE_POOL_LIMIT_PROFILE", "CREATE_RESTAPI_USER", "CREATE_SUBUNIT", "FREEZE_SIM", "MODIFY_REMARKS", "MOVE_SIM", "OVERRIDE_LIMIT", "PREACTIVATE_SIM", "PROFILE_VIOLATION", "REMOVE_APN_GRANT", "RESET_FRAUD_STATE", "RESET_LIMIT_STATE", "RESET_SIM_IN_HLR", "RESTORE_LIMIT", "RESTRICT_SIM", "SEND_SMS", "SET_MAX_PARALLEL_SESSIONS_PER_SIM", "SET_SIM_TO_PRODUCTIVE", "SIM_CONTRACT_SWITCH", "SIM_MODIFY", "SIM_ORDER", "SIM_ORDER_FROM_STOCK", "SIM_SUSPEND", "SIM_TAKEOVER", "SIM_UNSUSPEND", "SPECIAL_TERMINATE_SIM", "SYNC_PROFILE_WITH_MARIMBA", "TERMINATE_OPTION", "TERMINATE_PLS", "TERMINATE_PLS_OPTION", "TERMINATE_SIM", "UNBLOCK_SIM", "UNFREEZE_SIM", "UNRESTRICT_SIM" ]
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"creator" : {
"type" : "string"
},
"signupId" : {
"type" : "integer",
"format" : "int64"
},
"source" : {
"type" : "string",
"description" : "The source of an action.",
"enum" : [ "Customer Portal", "Sales Portal", "AAX² Customer Care GUI", "Customer API", "Customer API REST Service", "SIM Diagnostics", "OSS Notification Webservice", "IRIS Notification Webservice", "Internal Source" ]
},
"status" : {
"type" : "string",
"enum" : [ "open", "done", "error", "rejected" ]
}
}
}
}
},
"ActionStatus" : {
"type" : "object",
"example" : null,
"properties" : {
"actionStatus" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self, related (cancel action)"
},
"affectedSims" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"createTime" : {
"type" : "string"
},
"creator" : {
"type" : "string"
},
"originalRequest" : {
"type" : "string",
"description" : "Only provided for actions started via the Customer REST API, otherwise this element is null."
},
"status" : {
"type" : "string",
"enum" : [ "open", "done", "error", "rejected" ]
}
}
}
}
},
"AllocatedCustomer" : {
"type" : "object",
"example" : null,
"properties" : {
"allocatedCustomer" : {
"required" : [ "companyName", "partnerId" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self, sims"
},
"companyName" : {
"type" : "string"
},
"isSubunitOf" : {
"type" : "string"
},
"partnerId" : {
"type" : "string"
}
}
}
}
},
"ApiError" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"message" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "OK", "ACCEPTED", "CREATED", "BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "TOO_MANY_REQUESTS", "INTERNAL_SERVER_ERROR", "SERVICE_UNAVAILABLE" ]
},
"timestamp" : {
"type" : "string"
}
}
},
"ApnToUnrestrict" : {
"required" : [ "apnName", "limitProfileZone" ],
"type" : "object",
"properties" : {
"apnName" : {
"type" : "string"
},
"limitProfileZone" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/LimitProfileZoneToUnrestrict"
}
}
},
"description" : "Required for unrestricting APN specific limit profiles. Do not send when unrestricting the whole SIM."
},
"BindEIDEUICCID" : {
"type" : "object",
"properties" : {
"euiccid" : {
"type" : "string"
},
"newEuiccid" : {
"type" : "string"
}
}
},
"BindEIDICCID" : {
"type" : "object",
"properties" : {
"iccid" : {
"type" : "string"
},
"newEuiccid" : {
"type" : "string"
}
}
},
"BindEIDIMEI" : {
"type" : "object",
"properties" : {
"imei" : {
"type" : "string"
},
"newEuiccid" : {
"type" : "string"
}
}
},
"BindEIDIMSI" : {
"type" : "object",
"properties" : {
"imsi" : {
"type" : "string"
},
"newEuiccid" : {
"type" : "string"
}
}
},
"BindEIDMSISDN" : {
"type" : "object",
"properties" : {
"msisdn" : {
"type" : "string"
},
"newEuiccid" : {
"type" : "string"
}
}
},
"BindEIDParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BindEIDEUICCID"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BindEIDICCID"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BindEIDIMEI"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BindEIDIMSI"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BindEIDMSISDN"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\n Apart from SIM identifier. If parameter newEuiccid is not provided, the existing profile will be unbound."
},
"CriticalSims" : {
"type" : "object",
"properties" : {
"blockedAutomatically" : {
"type" : "integer",
"format" : "int64"
},
"blockedManually" : {
"type" : "integer",
"format" : "int64"
},
"suspended" : {
"type" : "integer",
"format" : "int64"
},
"undefined" : {
"type" : "integer",
"format" : "int64"
}
}
},
"EuiccidWrapper" : {
"type" : "object",
"properties" : {
"euiccid" : {
"type" : "string"
}
}
},
"FraudState" : {
"type" : "object",
"properties" : {
"alarm" : {
"type" : "integer",
"format" : "int64"
},
"noFraudProfile" : {
"type" : "integer",
"format" : "int64"
},
"ok" : {
"type" : "integer",
"format" : "int64"
}
}
},
"GetActionListResultParameters" : {
"type" : "object",
"example" : null,
"properties" : {
"actionListResult" : {
"required" : [ "actions", "pageInfo" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"actions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Action"
}
},
"pageInfo" : {
"$ref" : "#/components/schemas/PageInfo"
}
}
}
}
},
"GetCurrentPoolUsageResult" : {
"type" : "object",
"example" : null,
"properties" : {
"poolUsageResult" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self"
},
"message" : {
"type" : "string"
},
"poolUsageList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PoolUsageEntry"
}
}
}
}
}
},
"GetCustomersResultParameters" : {
"type" : "object",
"example" : null,
"properties" : {
"User" : {
"required" : [ "allocatedCustomerList", "email", "firstName", "lastName", "login", "userName" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self"
},
"allocatedCustomerList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AllocatedCustomer"
}
},
"email" : {
"type" : "string"
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"login" : {
"type" : "string"
},
"userName" : {
"type" : "string"
}
}
}
}
},
"GetSimApiUsageResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimApiUsage" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer",
"format" : "int64"
}
}
}
}
},
"GetSimDetailsResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimDetails" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self, session, session history"
},
"accessProfile" : {
"type" : "string"
},
"activationCode" : {
"type" : "string"
},
"barringProfile" : {
"type" : "string"
},
"bindingPeriod" : {
"type" : "string"
},
"bookedOptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimOption"
}
},
"busyState" : {
"type" : "string",
"enum" : [ "0", "1" ]
},
"costLimitProfile" : {
"type" : "string"
},
"eidProfileStatus" : {
"type" : "string",
"enum" : [ "FREE", "ALLOCATED", "BOUND", "RELEASED", "DOWNLOADED", "INSTALLED", "DELETED", "BOUNDANDRELEASED", "DOWNLOADERROR", "unset" ]
},
"euiccid" : {
"type" : "string"
},
"externalOfferingId" : {
"type" : "string"
},
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"fraudProfile" : {
"type" : "string"
},
"fraudStatus" : {
"type" : "string",
"enum" : [ "OK", "Alarm", "Suspended", "No profile" ]
},
"iccid" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"imsi" : {
"type" : "string"
},
"ipAddressConfig" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IpAddressConfig"
}
},
"limitProfile" : {
"type" : "string"
},
"limitStatus" : {
"type" : "string",
"enum" : [ "OK", "Warning", "Alarm", "Suspended", "No profile" ]
},
"msisdn" : {
"type" : "string"
},
"offering" : {
"type" : "string"
},
"restrictionStatus" : {
"type" : "string",
"enum" : [ "none", "SSD", "DR" ]
},
"simAggregatedData" : {
"$ref" : "#/components/schemas/SimAggregateData"
},
"smsrid" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "Ordered", "Ordered for stock", "On Stock", "Delivered", "Test", "Productive", "Blocked (automatically)", "Blocked (manually)", "Blocked (by operator)", "Suspended", "Terminated", "Special Terminated", "Deleted", "Blocked (MNO)", "Undefined" ]
}
}
}
}
},
"GetSimListResultParameters" : {
"type" : "object",
"example" : null,
"properties" : {
"simListResult" : {
"required" : [ "pageInfo", "sims" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"pageInfo" : {
"$ref" : "#/components/schemas/PageInfo"
},
"sims" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Sim"
}
}
}
}
}
},
"GetSimParallelSessionResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimParallelSessionResult" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self"
},
"sessions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/GetSimSessionResult"
}
}
}
}
}
},
"GetSimSessionHistoryResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimSessionHistoryResult" : {
"required" : [ "pageInfo", "simSessionHistoryDetails" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self, first, prev, next, last"
},
"pageInfo" : {
"$ref" : "#/components/schemas/PageInfo"
},
"simSessionHistoryDetails" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimSessionHistoryDetail"
}
}
}
}
}
},
"GetSimSessionResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimSessionResult" : {
"required" : [ "iccid" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self"
},
"apnAddress" : {
"type" : "string"
},
"country" : {
"type" : "string"
},
"duration" : {
"type" : "integer",
"format" : "int64"
},
"iccid" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"ipAddress" : {
"type" : "string"
},
"ipv6AddressPrefix" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string"
},
"mcc" : {
"type" : "string"
},
"mnc" : {
"type" : "string"
},
"network" : {
"type" : "string"
},
"pdpType" : {
"type" : "string",
"enum" : [ "IPv4", "IPv6", "IPv4v6" ]
},
"ratType" : {
"type" : "string",
"enum" : [ "N/A", "Classic M2M", "NB-IoT" ]
},
"restrictionReason" : {
"type" : "string",
"enum" : [ "", "SIM restricted due to detected device fraud", "SIM restricted due to detected location fraud", "Data rate for session restricted", "Data transmission for session blocked" ]
},
"sessionStart" : {
"type" : "string"
},
"volumeDownload" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeOverall" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeRounded" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeUpload" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
}
}
}
}
},
"GetSimStatesResult" : {
"type" : "object",
"example" : null,
"properties" : {
"simStates" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "criticalSims blockedAutomatically, criticalSims blockedManually, criticalSims suspended, criticalSims undefined, fraudState OK, fraudState alarm, limitState OK, limitState warning, limitState alarm, limitState suspended, simState totalSims, simState ordered, simState delivered, simState productive, simState test, simState terminated, simState special terminated, simState deleted"
},
"criticalSims" : {
"$ref" : "#/components/schemas/CriticalSims"
},
"fraudState" : {
"$ref" : "#/components/schemas/FraudState"
},
"limitState" : {
"$ref" : "#/components/schemas/LimitState"
},
"simState" : {
"$ref" : "#/components/schemas/SimState"
}
}
}
}
},
"GetSimTransferDetailResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimTransferDetails" : {
"required" : [ "pageInfo" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"completionDate" : {
"type" : "string"
},
"error" : {
"type" : "string",
"description" : "OSS errors occurred during SIM Transfer workflow processing.",
"enum" : [ "Yes", "No" ]
},
"id" : {
"type" : "integer",
"format" : "int64"
},
"notePartnerA" : {
"type" : "string"
},
"notePartnerB" : {
"type" : "string"
},
"pageInfo" : {
"$ref" : "#/components/schemas/PageInfo"
},
"partnerA" : {
"type" : "string"
},
"partnerB" : {
"type" : "string"
},
"selectedFields" : {
"$ref" : "#/components/schemas/SelectedFields"
},
"simTransfer" : {
"$ref" : "#/components/schemas/SimTransfer"
},
"startDate" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "process started", "completed", "rejected", "cancelled", "approved" ]
},
"subunitPartnerID" : {
"type" : "string"
}
}
}
}
},
"GetSimTransferListResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimTransferList" : {
"required" : [ "simTransferList" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"info" : {
"$ref" : "#/components/schemas/PageInfo"
},
"simTransferList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimTransferListEntry"
}
}
}
}
}
},
"GetSmsHistoryResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SmsHistoryResult" : {
"required" : [ "pageinfo", "smsHistoryData" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"pageinfo" : {
"$ref" : "#/components/schemas/PageInfo"
},
"smsHistoryData" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SmsHistoryData"
}
}
}
}
}
},
"IccidWrapper" : {
"type" : "object",
"properties" : {
"iccid" : {
"type" : "string"
}
}
},
"ImeiWrapper" : {
"type" : "object",
"properties" : {
"imei" : {
"type" : "string"
}
}
},
"ImsiWrapper" : {
"type" : "object",
"properties" : {
"imsi" : {
"type" : "string"
}
}
},
"IpAddress" : {
"type" : "object",
"properties" : {
"ipAddress" : {
"type" : "string"
},
"ipAddressType" : {
"type" : "string",
"enum" : [ "IPv4", "IPv6", "IPv4v6" ]
}
}
},
"IpAddressConfig" : {
"type" : "object",
"properties" : {
"apnName" : {
"type" : "string"
},
"ipAddresses" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IpAddress"
}
}
}
},
"LimitProfileZoneToUnrestrict" : {
"required" : [ "zoneName" ],
"type" : "object",
"properties" : {
"additionalSessions" : {
"minimum" : 0,
"type" : "integer",
"format" : "int64"
},
"additionalVolume" : {
"minimum" : 0,
"type" : "integer",
"description" : "If provided, additionalVolumeUnit also needs to be provided.",
"format" : "int64"
},
"additionalVolumeUnit" : {
"type" : "string",
"enum" : [ "B", "KB", "MB", "GB" ]
},
"zoneName" : {
"type" : "string"
}
}
},
"LimitState" : {
"type" : "object",
"properties" : {
"alarm" : {
"type" : "integer",
"format" : "int64"
},
"noLimitProfile" : {
"type" : "integer",
"format" : "int64"
},
"ok" : {
"type" : "integer",
"format" : "int64"
},
"suspended" : {
"type" : "integer",
"format" : "int64"
},
"warning" : {
"type" : "integer",
"format" : "int64"
}
}
},
"Link" : {
"type" : "object",
"properties" : {
"deprecation" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"hreflang" : {
"type" : "string"
},
"media" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"profile" : {
"type" : "string"
},
"rel" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
},
"description" : "action"
},
"MsisdnWrapper" : {
"type" : "object",
"properties" : {
"msisdn" : {
"type" : "string"
}
}
},
"MultipleSignUpCreationResult" : {
"type" : "object",
"example" : null,
"properties" : {
"MultipleSignUpCreationResult" : {
"required" : [ "signupIds", "successMessage" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "actions"
},
"signupIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"successMessage" : {
"type" : "string"
}
}
}
}
},
"PageInfo" : {
"required" : [ "currentPage", "nrOfPages", "overallAmount", "pageSize" ],
"type" : "object",
"properties" : {
"currentPage" : {
"type" : "integer",
"format" : "int64"
},
"nrOfPages" : {
"type" : "integer",
"format" : "int64"
},
"overallAmount" : {
"type" : "integer",
"format" : "int64"
},
"pageSize" : {
"type" : "integer",
"format" : "int64"
}
}
},
"PoolUsageEntry" : {
"type" : "object",
"example" : null,
"properties" : {
"poolUsage" : {
"type" : "object",
"properties" : {
"monitoringPeriod" : {
"type" : "integer",
"format" : "int64"
},
"offering" : {
"type" : "string"
},
"offeringId" : {
"type" : "integer",
"format" : "int64"
},
"periodEndDate" : {
"type" : "string"
},
"periodStartDate" : {
"type" : "string"
},
"poolName" : {
"type" : "string"
},
"volumeConsumed" : {
"type" : "number",
"description" : "Volume in MB"
},
"volumeInPool" : {
"type" : "number",
"description" : "Volume in MB"
}
}
}
}
},
"ProfileDataParameters" : {
"type" : "object",
"properties" : {
"accessProfileId" : {
"type" : "integer",
"description" : "Mandatory for non SCS tariffs.",
"format" : "int64"
},
"barringProfileId" : {
"type" : "integer",
"format" : "int64"
},
"costLimitProfileId" : {
"type" : "integer",
"format" : "int64"
},
"fraudProfileId" : {
"type" : "integer",
"format" : "int64"
},
"limitProfileId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ProfileStringParameters" : {
"type" : "object",
"properties" : {
"accessProfileId" : {
"type" : "string"
},
"barringProfileId" : {
"type" : "string"
},
"costLimitProfileId" : {
"type" : "string"
},
"fraudProfileId" : {
"type" : "string"
},
"limitProfileId" : {
"type" : "string"
}
}
},
"ResetSimInHLRParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"RootResource" : {
"type" : "object",
"example" : null,
"properties" : {
"Root" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self, customers"
},
"info" : {
"type" : "string"
}
}
}
}
},
"SelectedFields" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string",
"description" : "Remark field 1 transferred.",
"enum" : [ "YES", "NO" ]
},
"field10" : {
"type" : "string",
"description" : "Remark field 10 transferred.",
"enum" : [ "YES", "NO" ]
},
"field2" : {
"type" : "string",
"description" : "Remark field 2 transferred.",
"enum" : [ "YES", "NO" ]
},
"field3" : {
"type" : "string",
"description" : "Remark field 3 transferred.",
"enum" : [ "YES", "NO" ]
},
"field4" : {
"type" : "string",
"description" : "Remark field 4 transferred.",
"enum" : [ "YES", "NO" ]
},
"field5" : {
"type" : "string",
"description" : "Remark field 5 transferred.",
"enum" : [ "YES", "NO" ]
},
"field6" : {
"type" : "string",
"description" : "Remark field 6 transferred.",
"enum" : [ "YES", "NO" ]
},
"field7" : {
"type" : "string",
"description" : "Remark field 7 transferred.",
"enum" : [ "YES", "NO" ]
},
"field8" : {
"type" : "string",
"description" : "Remark field 8 transferred.",
"enum" : [ "YES", "NO" ]
},
"field9" : {
"type" : "string",
"description" : "Remark field 9 transferred.",
"enum" : [ "YES", "NO" ]
}
}
},
"SendMessageParameter" : {
"required" : [ "message" ],
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "Content of the SMS",
"example" : "Hello. This is a test SMS."
}
}
},
"SendMessageWithIdentifierParameter" : {
"required" : [ "message" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"message" : {
"type" : "string",
"description" : "Content of the SMS",
"example" : "Hello. This is a test SMS."
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
}
},
"ShippingAddress" : {
"required" : [ "city", "companyName", "country", "firstName", "houseNumber", "lastName", "postalCode", "salutation", "street" ],
"type" : "object",
"properties" : {
"additionToAddress1" : {
"type" : "string",
"description" : "Max allowed length of additional address 1 value is 35",
"example" : "Ally 160"
},
"additionToAddress2" : {
"type" : "string",
"description" : "Max allowed length of additional address 2 value is 35",
"example" : "Lane 3"
},
"additionalInformation" : {
"type" : "string",
"description" : "Max allowed length of additional information value is 35",
"example" : "thanks"
},
"attention" : {
"type" : "string",
"description" : "Max allowed length of attention value is 100",
"example" : "John Dao"
},
"city" : {
"type" : "string",
"description" : "Max allowed length of city value is 25",
"example" : "Taipei"
},
"companyName" : {
"type" : "string",
"description" : "Max allowed length of company name vale is 255",
"example" : "XZeus"
},
"country" : {
"type" : "string",
"description" : "Max allowed length of country value is 100",
"example" : "Taiwan"
},
"firstName" : {
"type" : "string",
"description" : "Max allowed length of first name value is 40",
"example" : "John"
},
"houseNumber" : {
"type" : "string",
"description" : "Max allowed length of house number value is 10",
"example" : "5978"
},
"lastName" : {
"type" : "string",
"description" : "Max allowed length of last name value is 40",
"example" : "Dao"
},
"postalCode" : {
"type" : "string",
"description" : "Max allowed length of postal code value is 10",
"example" : "987"
},
"salutation" : {
"type" : "string",
"description" : "Salutation for the receiver.",
"enum" : [ "Mr.", "Mrs.", "Company" ]
},
"street" : {
"type" : "string",
"description" : "Max allowed length of street value is 100",
"example" : "FuXing"
}
},
"description" : "Address to ship the ordered SIMs to"
},
"SignUpCreationResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SignUpCreationResult" : {
"required" : [ "signupId", "successMessage" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "actions, sims (SIM Move only)"
},
"signupId" : {
"type" : "integer",
"format" : "int64"
},
"successMessage" : {
"type" : "string"
}
}
}
}
},
"Sim" : {
"type" : "object",
"example" : null,
"properties" : {
"sim" : {
"required" : [ "iccid" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "self"
},
"euiccid" : {
"type" : "string"
},
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"iccid" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"imsi" : {
"type" : "string"
},
"ipAddressConfig" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IpAddressConfig"
}
},
"msisdn" : {
"type" : "string"
},
"simAggregatedData" : {
"$ref" : "#/components/schemas/SimAggregateData"
},
"status" : {
"type" : "string",
"enum" : [ "Blocked (automatically)", "Blocked (by operator)", "Blocked (manually)", "Blocked (MNO)", "Deleted", "Delivered", "On Stock", "Ordered", "Ordered for stock", "Productive", "Special Terminated", "Suspended", "Terminated", "Test", "Undefined" ]
}
},
"description" : "List of successfully transferred SIMs (only provided for the receiving partner)"
}
}
},
"SimActivationEUICCID" : {
"type" : "object",
"properties" : {
"euiccid" : {
"type" : "string"
},
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimActivationICCID" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"iccid" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimActivationIMEI" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimActivationIMSI" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"imsi" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimActivationParameters" : {
"type" : "object",
"properties" : {
"activationTemplateId" : {
"type" : "integer",
"description" : "If provided, offering, options, profiles are taken from the activation template and not from the payload.",
"format" : "int64"
},
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimActivationEUICCID"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimActivationICCID"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimActivationIMEI"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimActivationIMSI"
}
},
"offeringId" : {
"type" : "integer",
"description" : "Mandatory when not using an activation template.",
"format" : "int64"
},
"optionIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"profileDataParameters" : {
"$ref" : "#/components/schemas/ProfileDataParameters"
},
"startDtRequested" : {
"type" : "string",
"description" : "Timestamp must have a Z at the end to mark it as UTC.",
"format" : "date-time",
"example" : "2022-07-14T00:00:00Z"
},
"useTestTariff" : {
"type" : "boolean",
"description" : "default: false"
}
},
"description" : "If an activation template is provided it is prioritized and offering, options, profiles are taken from the activation template and not from the payload."
},
"SimAggregateData" : {
"required" : [ "consumption", "unit" ],
"type" : "object",
"properties" : {
"consumption" : {
"type" : "integer",
"format" : "int64"
},
"unit" : {
"type" : "string",
"enum" : [ "KB" ]
}
}
},
"SimBlockParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimCancelParameter" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"pattern" : "^cancelled$",
"type" : "string",
"enum" : [ "cancelled" ]
}
}
},
"SimChangeTariffParameter" : {
"required" : [ "offeringId" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"offeringId" : {
"type" : "integer",
"format" : "int64"
},
"optionIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"startDtRequested" : {
"type" : "string",
"description" : "If not set, start as soon as possible.",
"format" : "date-time"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\nBesides SIM identifier, value for mandatory attribute offeringId must be given.\r\nAll timestamps must have a Z at the end to mark them as UTC. e.g. 2022-07-14T00:00:00.000Z"
},
"SimDetailsParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimEnterPrdouctiveStateParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimInHLRParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimModifyProfilesEUICCID" : {
"type" : "object",
"properties" : {
"euiccid" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimModifyProfilesICCID" : {
"type" : "object",
"properties" : {
"iccid" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimModifyProfilesIMEI" : {
"type" : "object",
"properties" : {
"imei" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimModifyProfilesIMSI" : {
"type" : "object",
"properties" : {
"imsi" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimModifyProfilesMSISDN" : {
"type" : "object",
"properties" : {
"msisdn" : {
"type" : "string"
},
"staticIpsPerApnList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StaticIpsPerApnParameter"
}
}
}
},
"SimModifyProfilesParameters" : {
"required" : [ "profileParameters" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyProfilesEUICCID"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyProfilesICCID"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyProfilesIMEI"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyProfilesIMSI"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyProfilesMSISDN"
}
},
"profileParameters" : {
"$ref" : "#/components/schemas/ProfileStringParameters"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimModifyRemarksEUICCID" : {
"type" : "object",
"properties" : {
"euiccid" : {
"type" : "string"
},
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
}
}
},
"SimModifyRemarksICCID" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"iccid" : {
"type" : "string"
}
}
},
"SimModifyRemarksIMEI" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"imei" : {
"type" : "string"
}
}
},
"SimModifyRemarksIMSI" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"imsi" : {
"type" : "string"
}
}
},
"SimModifyRemarksMSISDN" : {
"type" : "object",
"properties" : {
"field1" : {
"type" : "string"
},
"field10" : {
"type" : "string"
},
"field2" : {
"type" : "string"
},
"field3" : {
"type" : "string"
},
"field4" : {
"type" : "string"
},
"field5" : {
"type" : "string"
},
"field6" : {
"type" : "string"
},
"field7" : {
"type" : "string"
},
"field8" : {
"type" : "string"
},
"field9" : {
"type" : "string"
},
"msisdn" : {
"type" : "string"
}
}
},
"SimModifyRemarksParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyRemarksEUICCID"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyRemarksICCID"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyRemarksIMEI"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyRemarksIMSI"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SimModifyRemarksMSISDN"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\nField 1-10 is optional for the target SIM(s)."
},
"SimMoveParameters" : {
"required" : [ "recipient" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"recipient" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\n Apart from SIM identifier, recipient is also a mandatory attribute in the body."
},
"SimOption" : {
"type" : "object",
"properties" : {
"bindingPeriod" : {
"type" : "string"
},
"customerOffering" : {
"type" : "string"
},
"externalOfferingId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"SimOptionBookingParameter" : {
"required" : [ "optionsToAdd" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"optionsToAdd" : {
"type" : "array",
"description" : "Options to be added",
"items" : {
"type" : "integer",
"description" : "Options to be added",
"format" : "int64"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimOptionChangeParameter" : {
"required" : [ "optionToAdd", "optionToTerminate" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"optionToAdd" : {
"type" : "integer",
"description" : "The selected option which should replace the old one",
"format" : "int64"
},
"optionToTerminate" : {
"type" : "integer",
"description" : "The selected option which should be terminated",
"format" : "int64"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimOptionTerminationParameter" : {
"required" : [ "optionsToTerminate" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"optionsToTerminate" : {
"type" : "array",
"description" : "Options to be terminated",
"items" : {
"type" : "integer",
"description" : "Options to be terminated",
"format" : "int64"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimOrderParameter" : {
"required" : [ "numberOfSims", "shippingAddress", "simType", "startDtRequested" ],
"type" : "object",
"properties" : {
"note" : {
"type" : "string",
"description" : "Max. length allowed: 4000",
"example" : "Please send to 2nd floor directly"
},
"notificationEmailAddress" : {
"type" : "string",
"description" : "Max. length allowed: 100",
"example" : "john.dao@xzeus.com"
},
"numberOfSims" : {
"type" : "integer",
"description" : "Number of SIMs to be ordered",
"format" : "int64",
"example" : 10
},
"overrideMoq" : {
"type" : "boolean",
"description" : "Allows overriding of the minimum order quantity. Default: false"
},
"shippingAddress" : {
"$ref" : "#/components/schemas/ShippingAddress"
},
"simType" : {
"type" : "string",
"description" : "Max. length allowed: 100",
"example" : "Basic_2FF_Test"
},
"startDtRequested" : {
"type" : "string",
"description" : "Requested start date",
"format" : "date-time"
}
}
},
"SimOverrideLimitStatusParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimResetFraudStatusParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimResetLimitStatusParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimRestoreLimitStatusParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimRestrictParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimSessionHistoryDetail" : {
"type" : "object",
"example" : null,
"properties" : {
"SimSessionHistoryDetail" : {
"required" : [ "iccid", "startTime" ],
"type" : "object",
"properties" : {
"abortReason" : {
"type" : "string",
"description" : "0: Aborted due to other technical reasons.
1: The user initiated a disconnect.
2: The user disconnected prior to the receipt of the authorization answer message.
3: The authorization answer received by the access device was not processed successfully.
4: The user was not granted access, or was disconnected, due to administrative reasons, such as the receipt of a Abort-Session-Request message.
5: The communication to the user was abruptly disconnected.
6: The user’s access was terminated since its authorized session time has expired.
7: The user is receiving services from another access device.
8: The user’s session has timed out, and service has been terminated.",
"enum" : [ "", "0", "1", "2", "3", "4", "5", "6", "7", "8" ]
},
"apnAddress" : {
"type" : "string"
},
"country" : {
"type" : "string"
},
"duration" : {
"type" : "integer",
"format" : "int64"
},
"iccid" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"ipv4Address" : {
"type" : "string"
},
"ipv6AddressPrefix" : {
"type" : "string"
},
"mcc" : {
"type" : "string"
},
"mnc" : {
"type" : "string"
},
"network" : {
"type" : "string"
},
"pdpType" : {
"type" : "string",
"enum" : [ "IPv4", "IPv6", "IPv4v6" ]
},
"ratType" : {
"type" : "string",
"enum" : [ "N/A", "Classic M2M", "NB-IoT" ]
},
"rejectReason" : {
"type" : "string",
"enum" : [ "", "The IMSI is not registered", "Device fraud detected", "Location fraud detected", "Testing limits reached", "Another open session exists for SIM", "Session cannot be authorized due to its status", "IP address from internal pool cannot be assigned", "Establishing connection in this zone is not allowed", "SIM blocked due to usage threshold exceeded", "Limit reached for SIM group (group are not blocked yet)", "The proxy server did not receive response from external radius server in time", "External RADIUS server rejected the request", "Session cannot be authorized due to incorrect username", "Session cannot be authorized due to incorrect APN password", "Cannot get data from ARP LDAP", "SIM has barred data in LDAP", "Unknown ARP ID", "Network operator not permitted", "Too many requests to CNTDB per second. Throttling mechanism blocked session attempt" ]
},
"restrictionReason" : {
"type" : "string",
"enum" : [ "", "SIM restricted due to detected device fraud", "SIM restricted due to detected location fraud", "Data rate for session restricted", "Data transmission for session blocked" ]
},
"startTime" : {
"type" : "string"
},
"stopTime" : {
"type" : "string"
},
"volumeDownload" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeOverall" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeOverallRounded" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
},
"volumeUpload" : {
"type" : "integer",
"description" : "Volume in Bytes",
"format" : "int64"
}
}
}
}
},
"SimSessionHistoryParameter" : {
"type" : "object",
"properties" : {
"dateFrom" : {
"type" : "string",
"description" : "Start date of the search query. If not provided, dateTo minus 7 days will be used. All timestamps must have a Z at the end to mark them as UTC.",
"format" : "date-time",
"example" : "2022-07-07T00:00:00Z"
},
"dateTo" : {
"type" : "string",
"description" : "End date of the search query. If not provided, current time will be used. All timestamps must have a Z at the end to mark them as UTC.",
"format" : "date-time",
"example" : "2022-07-14T00:00:00Z"
},
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"page" : {
"maximum" : 10000,
"minimum" : 1,
"type" : "integer",
"description" : "The number of the specific page of listed session history records to specific SIM. Max. up to 10000",
"format" : "int64",
"example" : 1
},
"size" : {
"maximum" : 50,
"minimum" : 1,
"type" : "integer",
"description" : "The amount per page of returned session history records to specific SIM. Max. up to 50",
"format" : "int64",
"example" : 10
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimSessionParameter" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"parallelSessions" : {
"type" : "boolean",
"description" : "Optional parameter to specify if the result considers parallel sessions. Default: false",
"example" : false
},
"refreshSession" : {
"type" : "boolean",
"description" : "Optional parameter to specify if the session is refreshable. Default: false",
"example" : false
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimState" : {
"type" : "object",
"properties" : {
"activated" : {
"type" : "integer",
"format" : "int64"
},
"delivered" : {
"type" : "integer",
"format" : "int64"
},
"others" : {
"type" : "integer",
"format" : "int64"
},
"terminated" : {
"type" : "integer",
"format" : "int64"
},
"totalSims" : {
"type" : "integer",
"format" : "int64"
}
}
},
"SimSuspendParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimTerminationParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"specialTermination" : {
"type" : "boolean"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\nBesides SIM identifier, attribute specialTermination is also mandatory and has default value 'false'. Set to 'true' if special termination is required."
},
"SimTransfer" : {
"type" : "object",
"properties" : {
"amountError" : {
"type" : "integer",
"format" : "int64"
},
"amountOverall" : {
"type" : "integer",
"format" : "int64"
},
"amountStillPending" : {
"type" : "integer",
"format" : "int64"
},
"amountSuccess" : {
"type" : "integer",
"format" : "int64"
},
"sims" : {
"type" : "array",
"description" : "List of successfully transferred SIMs (only provided for the receiving partner)",
"items" : {
"$ref" : "#/components/schemas/Sim"
}
}
}
},
"SimTransferCreationParameters" : {
"required" : [ "recipient" ],
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"notePartnerA" : {
"type" : "string"
},
"recipient" : {
"type" : "string"
},
"transferRemark01" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark02" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark03" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark04" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark05" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark06" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark07" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark08" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark09" : {
"type" : "boolean",
"description" : "default: false"
},
"transferRemark10" : {
"type" : "boolean",
"description" : "default: false"
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request.\r\n Apart from SIM identifier, recipient is also a mandatory attribute in the body."
},
"SimTransferCreationResult" : {
"type" : "object",
"example" : null,
"properties" : {
"SimTransferCreationResult" : {
"required" : [ "successMessage", "transactionId" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "first, prev, next, last"
},
"successMessage" : {
"type" : "string"
},
"transactionId" : {
"type" : "integer",
"format" : "int64"
}
}
}
}
},
"SimTransferListEntry" : {
"type" : "object",
"example" : null,
"properties" : {
"sim_transfer" : {
"type" : "object",
"properties" : {
"completionDate" : {
"type" : "string"
},
"error" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int64"
},
"linkToDetail" : {
"$ref" : "#/components/schemas/Link"
},
"numberOfSims" : {
"type" : "integer",
"format" : "int64"
},
"partnerA" : {
"type" : "string"
},
"partnerB" : {
"type" : "string"
},
"startDate" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "process started", "completed", "rejected", "cancelled", "approved" ]
}
}
}
}
},
"SimTransferUpdateParameters" : {
"required" : [ "action" ],
"type" : "object",
"properties" : {
"action" : {
"type" : "string",
"description" : "accept (recipient action), reject (recipient action), abort (sender action)",
"enum" : [ "accept", "reject", "abort" ]
},
"activationTemplateId" : {
"type" : "integer",
"description" : "If provided, offering, options, profiles, remark fields are taken from the activation template and not from the payload.",
"format" : "int64"
},
"note" : {
"type" : "string",
"description" : "Max. length: 1024 characters"
},
"offeringId" : {
"type" : "integer",
"description" : "Mandatory when transferring active SIM cards, except for when using an activation template.",
"format" : "int64"
},
"optionIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
},
"profileDataParameters" : {
"$ref" : "#/components/schemas/ProfileDataParameters"
},
"remark01" : {
"type" : "string",
"description" : "Set remark 1. Max. length: 300 characters"
},
"remark02" : {
"type" : "string",
"description" : "Set remark 2. Max. length: 300 characters"
},
"remark03" : {
"type" : "string",
"description" : "Set remark 3. Max. length: 300 characters"
},
"remark04" : {
"type" : "string",
"description" : "Set remark 4. Max. length: 300 characters"
},
"remark05" : {
"type" : "string",
"description" : "Set remark 5. Max. length: 300 characters"
},
"remark06" : {
"type" : "string",
"description" : "Set remark 6. Max. length: 300 characters"
},
"remark07" : {
"type" : "string",
"description" : "Set remark 7. Max. length: 300 characters"
},
"remark08" : {
"type" : "string",
"description" : "Set remark 8. Max. length: 300 characters"
},
"remark09" : {
"type" : "string",
"description" : "Set remark 9. Max. length: 300 characters"
},
"remark10" : {
"type" : "string",
"description" : "Set remark 10. Max. length: 300 characters"
},
"subunitPartnerID" : {
"type" : "string",
"description" : "If provided, SIM cards are shifted to this subunit when accepting the transfer."
},
"transferRemark01" : {
"type" : "boolean",
"description" : "Transfer remark 1 from sending partner. During SIM Transfer creation, remark 1 has to be marked to be eligible to be transferred."
},
"transferRemark02" : {
"type" : "boolean",
"description" : "Transfer remark 2 from sending partner. During SIM Transfer creation, remark 2 has to be marked to be eligible to be transferred."
},
"transferRemark03" : {
"type" : "boolean",
"description" : "Transfer remark 3 from sending partner. During SIM Transfer creation, remark 3 has to be marked to be eligible to be transferred."
},
"transferRemark04" : {
"type" : "boolean",
"description" : "Transfer remark 4 from sending partner. During SIM Transfer creation, remark 4 has to be marked to be eligible to be transferred."
},
"transferRemark05" : {
"type" : "boolean",
"description" : "Transfer remark 5 from sending partner. During SIM Transfer creation, remark 5 has to be marked to be eligible to be transferred."
},
"transferRemark06" : {
"type" : "boolean",
"description" : "Transfer remark 6 from sending partner. During SIM Transfer creation, remark 6 has to be marked to be eligible to be transferred."
},
"transferRemark07" : {
"type" : "boolean",
"description" : "Transfer remark 7 from sending partner. During SIM Transfer creation, remark 7 has to be marked to be eligible to be transferred."
},
"transferRemark08" : {
"type" : "boolean",
"description" : "Transfer remark 8 from sending partner. During SIM Transfer creation, remark 8 has to be marked to be eligible to be transferred."
},
"transferRemark09" : {
"type" : "boolean",
"description" : "Transfer remark 9 from sending partner. During SIM Transfer creation, remark 9 has to be marked to be eligible to be transferred."
},
"transferRemark10" : {
"type" : "boolean",
"description" : "Transfer remark 10 from sending partner. During SIM Transfer creation, remark 10 has to be marked to be eligible to be transferred."
}
},
"description" : "To transfer active SIMs, offeringId and profileParameters.accessProfileId (non SCS tariffs only) are mandatory. If an activation template is provided it is prioritized and offering, options, profiles, remark fields are taken from the activation template and not from the payload."
},
"SimUnSuspendParameters" : {
"type" : "object",
"properties" : {
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimUnblockParameter" : {
"type" : "object",
"properties" : {
"additionalSessionLimit" : {
"type" : "integer",
"description" : "Session limit value",
"format" : "int64",
"example" : 10
},
"additionalUsageLimitValue" : {
"type" : "integer",
"description" : "Usage limit value",
"format" : "int64",
"example" : 100
},
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"unit" : {
"type" : "string",
"enum" : [ "B", "KB", "MB", "GB" ]
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SimUnrestrictParameter" : {
"type" : "object",
"properties" : {
"apnsToUnrestrict" : {
"type" : "array",
"description" : "Required for unrestricting APN specific limit profiles. Do not send when unrestricting the whole SIM.",
"items" : {
"$ref" : "#/components/schemas/ApnToUnrestrict"
}
},
"euiccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"SmsHistoryData" : {
"type" : "object",
"properties" : {
"callingMsisdn" : {
"type" : "string"
},
"diagSetFinal" : {
"type" : "string"
},
"internalState" : {
"type" : "string"
},
"lastEventTime" : {
"type" : "string",
"format" : "date-time"
},
"origCalledMsisdn" : {
"type" : "string"
},
"retryCounter" : {
"type" : "integer",
"format" : "int64"
},
"sourceInterfaceType" : {
"type" : "string"
},
"submitTime" : {
"type" : "string",
"format" : "date-time"
},
"targetInterfaceType" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
},
"SmsHistoryParameter" : {
"type" : "object",
"properties" : {
"dateFrom" : {
"type" : "string",
"description" : "Start date of the search query. If not provided, dateTo minus 7 days will be used. All timestamps must have a Z at the end to mark them as UTC.",
"format" : "date-time",
"example" : "2022-07-07T00:00:00Z"
},
"dateTo" : {
"type" : "string",
"description" : "End date of the search query. If not provided, current time will be used. All timestamps must have a Z at the end to mark them as UTC.",
"format" : "date-time",
"example" : "2022-07-14T00:00:00Z"
},
"euiccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EuiccidWrapper"
}
},
"iccidParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IccidWrapper"
}
},
"imeiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImeiWrapper"
}
},
"imsiParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ImsiWrapper"
}
},
"msisdnParameters" : {
"maxItems" : 1,
"minItems" : 0,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MsisdnWrapper"
}
},
"page" : {
"maximum" : 10000,
"minimum" : 1,
"type" : "integer",
"description" : "The number of the specific page of listed SMS history records to specific SIM. Max. up to 10000",
"format" : "int64",
"example" : 1
},
"size" : {
"maximum" : 50,
"minimum" : 1,
"type" : "integer",
"description" : "The amount per page of returned SMS history records to specific SIM. Max. up to 50",
"format" : "int64",
"example" : 10
}
},
"description" : "SIM identifier can be ICCID, IMSI, EUICCID, MSISDN or IMEI. Only one type of identifier allowed per request."
},
"StaticIpsPerApnParameter" : {
"type" : "object",
"properties" : {
"apnName" : {
"type" : "string"
},
"ipv4AddressList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"ipv6AddressList" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"UpdateSimTransferResult" : {
"type" : "object",
"example" : null,
"properties" : {
"UpdateSimTransfer" : {
"required" : [ "successMessage" ],
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/Link"
},
"description" : "sims"
},
"successMessage" : {
"type" : "string"
}
}
}
}
}
}
}
}