Get Subscription By Imsi V 2 - Mobility Services

{"type":"api","title":"Get Subscription By Imsi V 2","meta":{"id":"/apps/pubhub/media/wg2-provider-mobility-api/2399805c96165da845b7295c0f3523bddeb07dc4/38d14f13-d0e0-3d33-9aa3-fe0e0339af91","info":{"title":"Core Network APIs","description":"## Introduction to the Core Network REST APIs\n\nWelcome to the documentation for the Mobility Services REST APIs. This collection of APIs allows for the provisioning and management of subscriber services, handling various operations related to subscription profiles, SIM import, and more. The APIs are designed to be straightforward and intuitive, encapsulating complex telecommunications operations into simple API calls.\n\n### Overview\n\nThe APIs are grouped into two main categories:\n\n1. **Subscription Profile And Provisioning**: This set of APIs covers a broad range of functionalities related to subscriber profiles. Through these APIs, you can retrieve information about a subscription, activate a new subscription, update existing subscriptions, change SIMs, block or unblock SIMs, change MSISDN, terminate subscriptions, and more. It supports a variety of parameters and configurations allowing for a flexible management of subscriber services.\n\n2. **SIM Import (BETA)**: This API facilitates the import of SIMs to the Mobility Services platform. It provides the ability to specify essential SIM attributes like BSSID, ICCID, IMSIs, and cryptographic keys for provisioning SIMs. Please note that this SIM import API is not stable and is subject to change.\n\n### Authentication and Authorization\n\nThe APIs support OAuth2 Client Credentials flow for authentication, where clients can obtain a token from the specified token URL. Different scopes are defined for reading and writing subscription information, as well as importing SIM data.\n\n### Error Handling\n\nStandard HTTP status codes are used to indicate the success or failure of an API request. Specific error schemas are defined to provide more information about the error, including a description of the error and additional details if applicable.\n\n### Rate Limiting\n\nThe APIs have built-in rate limiting to ensure fair usage and to protect the system from abuse. Responses include standard headers to indicate the current rate limit status.\n","contact":{"email":"mobility-services-developer@cisco.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.0.0"},"externalDocs":{"description":"See docs.wgtwo.com","url":"https://docs.wgtwo.com"},"security":[{"operatorKey":[]},{"OAuth2":["subscription.read","subscription.write","sim.import.write"]}]},"spec":{"tags":["Subscription Profile v2"],"parameters":[{"name":"imsi","in":"path","description":"IMSI associated with the SIM of the subscription","required":true,"schema":{"type":"string","example":313460000000001}}],"summary":"Get information about subscription","operationId":"getSubscriptionByImsi_v2","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"msisdn":{"type":"string","example":"4799990000"},"active":{"type":"boolean","example":true},"userId":{"type":"string"},"bss":{"type":"string"},"simcards":{"type":"array","items":{"type":"object","properties":{"imsis":{"type":"array","items":{"type":"string","example":["(...)001","(...)002"]}},"iccid":{"type":"string"},"bss":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"activeImsi":{"type":"string"}}}},"services":{"type":"array","items":{"type":"object","required":["servicename"],"properties":{"servicename":{"type":"string","description":"Each service SERVICE_NAME_ROAM depends on the basic services SERVICE_NAME and ROAMING. For example, to make international calls\nwhile abroad you need to have all 3 services, ROAMING, VOICE_OUT_INTER and VOICE_OUT_INTER_ROAM.\n\nAll data services depend on also having the DATA service. It takes an optional unsigned integer-valued parameter, 'speed_bps' (bits per second), to allow throttling\nof data speed for all data sessions. If not specified, the QoS settings from the configured APN are used.\n","enum":["DATA","DATA_2G_3G","DATA_2G_3G_ROAM","DATA_4G","DATA_4G_ROAM","DATA_5G","DATA_5G_ROAM","DATA_TETHERING","DATA_CONTENT_FILTERING","MMS_IN","MMS_IN_ROAM","MMS_OUT","MMS_OUT_ROAM","MMS_OUT_INTER","MMS_OUT_INTER_ROAM","PRODUCT_BUNDLING","ROAMING","ROAMING_DATA","SMS_IN","SMS_IN_ROAM","SMS_OUT","SMS_OUT_ROAM","SMS_OUT_INTER","SMS_OUT_INTER_ROAM","SMS_PREMIUM","USER_CS_BLOCK_OUT","USER_CS_BLOCK_IN","USER_CS_BLOCK_OUT_INTER","USER_CS_BLOCK_OUT_INTER_EXC_HOME","VOICE_CALLFORWARD","VOICE_CALLWAITING","VOICE_CALLER_ID_PRESENTATION","VOICE_CALLER_ID_RESTRICTION","VOICE_CONFERENCE","VOICE_CALL_PARALLEL","VOICE_IN","VOICE_IN_ROAM","VOICE_MISSED_CALL_ALERT","VOICE_OUT","VOICE_OUT_ROAM","VOICE_OUT_INTER","VOICE_OUT_INTER_ROAM","VOICE_PREMIUM","VOICE_PREMIUM_INFO","VOICE_PREMIUM_ENTERTAINMENT","VOICE_VOLTE","VOICE_VOWIFI","VOICEMAIL_DISABLE_NOTIFICATION"],"$$ref":"#/components/schemas/ServiceNamesV2"},"config":{"type":"object","description":"An optional object to configure a service.\nThe properties supplied depend on the service being configured.\nPrevious config is modified by supplying a new config object that will overwrite the previous config.\nPrevious config is removed by not supplying config.\n","properties":{"active":{"type":"boolean","description":"Use this field to control the state of a supplementary service.\nActive = true means it is provisioned and active\nActive = false means it is provisioned but inactive\n\nThis field will be updated when a user toggles the state of the corresponding supplementary\nservice from the handset. If this field is provided when updating a provisioned service,\nthe state of the supplementary service will be updated both on the handset and to the\nnetwork.\n\nOmitting this field when provisioning a new supplementary service sets it to false\nby default. Omitting this field when updating a provisioned service leaves it unchanged.\n\nVOICE_CALLWAITING:\n service absent: call waiting is not available\n active = true: call waiting is active on the device\n active = false: call waiting is not currently active on the device, but can be made active\n\nVOICE_CALLER_ID_RESTRICTION:\n service absent: caller id always presented\n active = true: caller id never presented\n active = false: caller id can be hidden for selected calls\n\nUSER_CS_BLOCK_OUT:\n service absent: user cannot block all outgoing voice/sms on device (BAIC)\n active = true: user is blocking all outgoing voice/sms on device (BAIC)\n active = false: user is not blocking all outgoing voice/sms on device (BAIC), but can be made active\n\nUSER_CS_BLOCK_IN:\n service absent: user cannot block all incoming voice/sms on device (BAOC)\n active = true: user is blocking all incoming voice/sms on device (BAOC)\n active = false: user is not blocking incoming voice/sms on device (BAOC), but can be made active\n\nUSER_CS_BLOCK_OUT_INTER:\n service absent: user cannot block all outgoing international voice/sms on device (BOIC)\n active = true: user is blocking all outgoing international voice/sms on device (BOIC)\n active = false: user is not blocking outgoing international voice/sms on device (BOIC), but can be made active\n\nUSER_CS_BLOCK_OUT_INTER_EXC_HOME:\n service absent: user cannot block all outgoing international except home voice/sms on device (BOIC-exHc)\n active = true: user is blocking all outgoing international except home voice/sms on device (BOIC-exHc)\n active = false: user is not blocking outgoing international except home voice/sms on device (BOIC-exHc), but can be made active\n"},"speed_bps":{"type":"number","description":"Configure service DATA to throttle the download speed in bits per second.\nWhen the field is absent, or not configured globally for your tenant, the APN settings determine the maximum speed.\n\nContact us for more information to configure it globally.\n"},"forbidden_content":{"type":"array","items":{"type":"string","enum":["PORN","KID_SAFE","SOCIAL_MEDIA","VIOLENCE","TORRENTS","DRUGS","GAMBLING","GAMES","DATING","MEDIA","ALCOHOL_AND_TOBACCO","NUDITY","OBSCENE_AND_TASTELESS","FASHION_AND_BEAUTY","HOMEWORK","SEARCH_ENGINES_AND_PORTALS","SEX_EDUCATION","HATE_AND_SELF_HARM"],"$$ref":"#/components/schemas/ContentCategories"},"description":"Configure service DATA_CONTENT_FILTERING by supplying a list of forbidden content.\n"},"unconditional":{"type":"string","description":"Configure service VOICE_CALLFORWARD with the msisdn for unconditional forwarding."},"unconditional_active":{"type":"boolean","description":"Sets the active state for unconditional, if not explicitly set, the state will default\nto active if any number is set for unconditional.\n"},"busy":{"type":"string","description":"Configure service VOICE_CALLFORWARD with the msisdn for forwarding when callee is busy."},"busy_active":{"type":"boolean","description":"Sets the active state for busy, if not explicitly set, the state will default\nto active if any number is set for busy.\n"},"no_reply":{"type":"string","description":"Configure service VOICE_CALLFORWARD with the msisdn for forwarding when callee does not answer."},"no_reply_active":{"type":"boolean","description":"Sets the active state for no_reply, if not explicitly set, the state will default\nto active if any number is set for no_reply.\n"},"unreachable":{"type":"string","description":"Configure service VOICE_CALLFORWARD with the msisdn for forwarding when callee is not reachable."},"unreachable_active":{"type":"boolean","description":"Sets the active state for unreachable, if not explicitly set, the state will default\nto active if any number is set for unreachable.\n"}}}},"$$ref":"#/components/schemas/ServiceObject"}},"roamingprofile":{"type":"string"},"apnprofile":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"}},"$$ref":"#/components/schemas/SubscriptionV2"}}}},"401":{"description":"The client does not have valid credentials","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid or missing credentials"}},"$$ref":"#/components/schemas/AccessDenied"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"The client is not authorized to access this resource","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid or missing credentials"}},"$$ref":"#/components/schemas/AccessDenied"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Subscription not found","content":{}},"429":{"description":"The client has exceeded the rate limit","content":{"application/json":{"schema":{"type":"string","example":"Too Many Requests","$$ref":"#/components/schemas/RateLimitExceeded"}}},"$$ref":"#/components/responses/RateLimitExceeded"}},"__originalOperationId":"getSubscriptionByImsi.v2","security":[{"operatorKey":[]},{"OAuth2":["subscription.read","subscription.write","sim.import.write"]}],"method":"get","path":"/subscription/v2/imsi/{imsi}"}}