U Mobile’s OPGW Developers API collection is part of an initiative to adopt the GSMA Open Gateway framework and CAMARA API standards. This unified collection includes implementations of the Number Verification API and SIM Swap API, enabling secure mobile number validation and real-time SIM change detection through operator network capabilities. By aligning with GSMA and CAMARA specifications, U Mobile aims to promote interoperability, enhance security, and support innovation across the telecom ecosystem. This documentation is intended for developers and partners integrating with U Mobile’s APIs to build robust, trusted digital services.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49696612","collectionId":"ff95ead0-7be3-49f2-a773-d093861694ff","publishedId":"2sB3WvLdKk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-21T06:43:14.000Z"},"item":[{"name":"Number Verification API","item":[{"name":"ac/auth-service/openIDConnect/deviceinitiated/v1/authorize","item":[{"name":"authentication Frontend Request","id":"d7bbca12-136a-4327-98a2-f8411f850661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/ac/auth-service/openIDConnect/deviceinitiated/v1/authorize?client_id=string&scope=string&response_type=string&prompt=string&request=string&redirect_uri=string&state=string&nonce=string&login_hint=string&code_challenge=string&code_challenge_method=string","description":"The Application Client makes a request to Fronttend Authentication Endpoint to ask for end-user authorization. UM-OPG validates that the MSISDN is a valid MSISDN and checks for consent. If successful, it passes the request for further processing. Once UM-OPG processing is successful, a “code” is provided in the response to the Application Client.An authorization request must include either a signed request parameter or the standard parameters:client_id, redirect_uri, scope, and response_type.
\n","urlObject":{"path":["ac","auth-service","openIDConnect","deviceinitiated","v1","authorize"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Unique identifier for the client application requesting authorization.
\n","type":"text/plain"},"key":"client_id","value":"string"},{"description":{"content":"Specifies what permissions (scopes) the client is requesting.
\n","type":"text/plain"},"key":"scope","value":"string"},{"description":{"content":"Determines the type of response expected.
\n","type":"text/plain"},"key":"response_type","value":"string"},{"description":{"content":"Controls whether the authentication UI is displayed to the user.
\n","type":"text/plain"},"key":"prompt","value":"string"},{"description":{"content":"Signed JWT that encapsulates the authorization request parameters. It should contain client_id,response_type,scope,prompt,redirect_uri,iss,aud,iat and exp.
\n","type":"text/plain"},"key":"request","value":"string"},{"description":{"content":"The callback URL where the authorization server redirects the user after authentication. This must be pre-registered with the authorization server to prevent malicious redirections
\n","type":"text/plain"},"key":"redirect_uri","value":"string"},{"description":{"content":"A random unique value generated by the client and sent to the authorization server. Used to maintain session state and prevent CSRF attacks.
\n","type":"text/plain"},"key":"state","value":"string"},{"description":{"content":"A random unique value used to prevent replay attacks in OpenID Connect.
\n","type":"text/plain"},"key":"nonce","value":"string"},{"description":{"content":"specific user identifier
\n","type":"text/plain"},"key":"login_hint","value":"string"},{"description":{"content":"A hashed value of the code_verifier used for PKCE
\n","type":"text/plain"},"key":"code_challenge","value":"string"},{"description":{"content":"Defines the hashing method for code_challenge.
\n","type":"text/plain"},"key":"code_challenge_method","value":"string"}],"variable":[]}},"response":[],"_postman_id":"d7bbca12-136a-4327-98a2-f8411f850661"}],"id":"aee92dda-fea1-4d32-a2af-ede7ffca4b6a","_postman_id":"aee92dda-fea1-4d32-a2af-ede7ffca4b6a","description":""},{"name":"ac/auth-service/openIDConnect/deviceinitiated/v1/token","item":[{"name":"token Frontend Request","id":"d7847170-e898-43ab-8a25-a082b1ff0f68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Code value from fetch code API
\n","key":"code","value":"string"},{"description":"Redirect URI value to where user want to redirect. This has to be same as what is given in the auth request.
\n","key":"redirect_uri","value":"string"},{"description":"\"authorization_code\"
\n","key":"grant_type","value":"string"},{"description":"This parameter commonly used in OAuth 2.0 and OpenID Connect protocols to specify the type of client assertion being used for authentication in a client-server interaction.
\n","key":"client_assertion_type","value":"string"},{"description":"The client_assertion is a security measure used in authentication processes, especially within OAuth 2.0 and OpenID Connect, to authenticate the client (such as a web application, mobile app, or service) to an authorization server.
\n","key":"client_assertion","value":"string"},{"description":"\"number-verification-service-provided-by-nabstract\"
\n","key":"code_verifier","value":"string"}]},"url":"{{baseUrl}}/ac/auth-service/openIDConnect/deviceinitiated/v1/token","description":"The request to the token endpoint must be sent using the HTTP POST method and have parameters populated in accordance with the rules. In the token request, either the Authorization header or the client_assertion_type and client_assertion parameters must be provided.
\n","urlObject":{"path":["ac","auth-service","openIDConnect","deviceinitiated","v1","token"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7847170-e898-43ab-8a25-a082b1ff0f68"}],"id":"eb11433a-98be-4807-a835-cc8872aefa80","_postman_id":"eb11433a-98be-4807-a835-cc8872aefa80","description":""},{"name":"number-verification-service/number-verification/v1/verify","item":[{"name":"Verifies if the received hashed/plain text phone number matches the phone number associated with the access token","id":"ea87fb44-8249-4ae3-9208-0d8fa0b56a93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hashedPhoneNumber\": \"32f67ab4e4312618b09cd23ed8ce41b13e095fe52b73b2e8da8ef49830e50dba\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/number-verification-service/number-verification/v1/verify","description":"Verifies if the specified phone number (either in plain text or hashed format) matches the one that the user is currently using. Only one of the plain or hashed formats must be provided.
\ndevice phone number associated to the access tokenService Enabling Network Function API to verify that the provided mobile phone number is the one used in the device. It verifies that the user is using a device with the same mobile phone number as it is declared.
It also makes it possible for a Service provider to verify the number itself by returning the phone number associated to the authenticated user's access token.
In this API phone number term refers to the mobile phone number
\nThis enables a Service Provider (SP) to verify the phone number of the mobile device being used to access their service where the mobile device is accessing the service provider over a mobile network (WiFi connections are out of this API scope). This can happen either by getting the comparison result or receiving the phone number of the device that is used, so they can verify it themselves.
\nThis API currently provides two endpoints where both require a 3-legged token and authentication via mobile network (excluding for example by SMS/OTP or user/password as an authentication method):
\nThe first one checks if the user mobile phone number matches the phone number associated with the mobile device. It can receive either a hashed or a plain text phone number as input and it compares the received input with the authenticated user's phone number associated to the access token in order to respond true/false.
\nThe next one retrieves the phone number associated to the user's token and returns it so the verification can be made by the service provider.
\nNumber Verification API uses the standard OAuth2 Authorization Code grant. The following diagram will help to clarify the end-to-end process, including previous steps prior to this API call.
\n![\"UML](\"https://raw.githubusercontent.com/camaraproject/NumberVerification/main/documentation/API_documentation/assets/uml_v0.3.jpg\")
\n\nAdditional details:
\n(1): Authentication must be automatic without any user interactions. Authentication methods such as SMS OTP or user/password are incompatible, as the goal is to validate the mobile phone number that is accessing the App. So it is required to be authentication via mobile network and without the user being involved. the use of parameter prompt=none, as described in OIDC Connect, ensures no user interaction.
\n(2): The way in which the phone_number is retrieved depends on the implementation. For example, access token may be a self contained encrypted JWT, so API can decrypt and identify phone_number. Some other implementations might request the phone_number associated to the token from Authserver.
\nContact Support:
Name: API Support
Email: awsgsma@u.com.my
unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"End-user for whom the authentication is being requested. This is MSISDN in the format “tel:+{MSISDN}”, where +\" prefix is optional. Examples: “tel:+447123456789” or “tel:34712345678”.
\n","key":"login_hint","value":"tel:+447123456789"},{"description":"Authorization request MUST contain the scope value.
\n","key":"scope","value":"retrieve-sim-swap-date"},{"key":"request","value":"string"},{"description":"This parameter commonly used in OAuth 2.0 and OpenID Connect protocols to specify the type of client assertion being used for authentication in a client-server interaction.
\n","key":"client_assertion_type","value":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer"},{"description":"The client_assertion is a security measure used in authentication processes, especially within OAuth 2.0 and OpenID Connect, to authenticate the client (such as a web application, mobile app, or service) to an authorization server.
\n","key":"client_assertion","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJjbGllZW50LWlkI........"}]},"url":"{{baseUrl}}/openIDConnectCIBA/v1/bc-authorize","description":"The SP makes a request to Backchannel Authentication Endpoint to ask for end-user authorization. NIOP validates the MSISDN is a valid MSISDN and checks consent. If successful, it passes the request to the NIOP for processing. Once NIOP processing is successful, an “auth_req_id” is provided in the response to the SP.
\n","urlObject":{"path":["openIDConnectCIBA","v1","bc-authorize"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21199c5d-6c0e-45bf-995f-81f07b1ca9cb"}],"id":"ed5a7ed4-61db-435c-9e70-510fc49f9eb5","_postman_id":"ed5a7ed4-61db-435c-9e70-510fc49f9eb5","description":""},{"name":"oauth/v1/token","item":[{"name":"oath Token Request","id":"4d03a3a9-38ad-4db9-b6ad-9caeff4467f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"End-user for whom the authentication is being requested. This is MSISDN in the format “tel:+{MSISDN}”, where +\" prefix is optional. Examples: “tel:+447123456789” or “tel:34712345678”.
\n","key":"username","value":"tel:+447123456789"},{"description":"Authorization request MUST contain the scope value.
\n","key":"scope","value":"retrieve-sim-swap-date"},{"description":"This parameter is used in OAuth 2.0 authorization flows to specify how a client application should obtain an access token from the authorization server.
\n","key":"grant_type","value":"client_credentials"},{"description":"This parameter commonly used in OAuth 2.0 and OpenID Connect protocols to specify the type of client assertion being used for authentication in a client-server interaction.
\n","key":"client_assertion_type","value":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer"},{"description":"The client_assertion is a security measure used in authentication processes, especially within OAuth 2.0 and OpenID Connect, to authenticate the client (such as a web application, mobile app, or service) to an authorization server.
\n","key":"client_assertion","value":"retrieve-sim-swap-date"}]},"url":"{{baseUrl}}/oauth/v1/token","description":"The request to the token endpoint must be sent using the HTTP POST method and have parameters populated in accordance with the rules
\n","urlObject":{"path":["oauth","v1","token"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d03a3a9-38ad-4db9-b6ad-9caeff4467f8"}],"id":"cf67d2e4-3c9b-437c-a995-09fdd1147a69","_postman_id":"cf67d2e4-3c9b-437c-a995-09fdd1147a69","description":""},{"name":"retrieve-date","item":[{"name":"retrieve Sim Swap Date","id":"2b1379ac-e952-47b0-aa39-9a8e84f5f82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"nabApplnClientId
\n","key":"nabApplnClientId","value":"string"},{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"description":"invoker's key
\n","key":"x-identity-key","value":"string"},{"description":"unique id to trace call between two services
\n","key":"x-request-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phoneNumber\": \"+346661113334\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve-date","description":"Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
\n","urlObject":{"path":["retrieve-date"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b1379ac-e952-47b0-aa39-9a8e84f5f82e"}],"id":"4978b893-ed9a-4040-9bd3-d45d7396ce34","_postman_id":"4978b893-ed9a-4040-9bd3-d45d7396ce34","description":""},{"name":"check","item":[{"name":"check Sim Swap","id":"3e4803e3-1a99-41d2-8ca3-6e910f53b47f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"nabApplnClientId
\n","key":"nabApplnClientId","value":"string"},{"description":"unique trace id to trace end to end system call
\n","key":"x-correlator","value":"string"},{"description":"invoker's key
\n","key":"x-identity-key","value":"string"},{"description":"unique id to trace call between two services
\n","key":"x-request-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phoneNumber\": \"+346661113334\",\n \"maxAge\": 240\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/check","description":"Check if SIM swap has been performed during a past period
\n","urlObject":{"path":["check"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e4803e3-1a99-41d2-8ca3-6e910f53b47f"}],"id":"693913de-8b2f-4544-96ff-d627968ed4ed","_postman_id":"693913de-8b2f-4544-96ff-d627968ed4ed","description":""}],"id":"8da97986-e904-44af-bc8d-c037ce115531","description":"The SIM swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period.
\nThe SIM Swap API performs real-time checks on the last SIM Swap event.
\nThe SIM Swap API is useful to prevent fraud by reducing the risk of account takeover fraud by strengthening SIM based authentication processes such as SMS One-time passwords. Fraudsters are using SIM swap techniques to intercept SMS messages and reset passwords or receive verification codes that allow them to access protected accounts.
\nThe SIM Swap API can also be used to protect non-automated actions. For example, when a call center expect contacts a user to clarify or confirm a sensitive operation.
\nThis API is used by an application to get information about a mobile line latest SIM swap date. It can be easily integrated and used through this secured API and allows SPs (Service Provider) to get this information an easy & secured way. The API provides management of 2 endpoints answering 2 distinct questions:
\nWhen did the last SIM swap occur?
\nHas a SIM swap occurred during last n hours?
\nDepending on the network provider implementation, legal enforcement, etc... either one or both endpoints could be implemented.
\nSIM swap:
A SIM swap is a process in which a user's mobile phone number (MSISDN) is associated with a new SIM card (IMSI). This is typically done by contacting the user's mobile service provider and requesting a new SIM card for various reasons, such as a lost or damaged SIM card or upgrading to a new phone.
SimSwap also happens during other actions like changing user's phone number, changing mobile service provider keeping user's mobile phone number or when activating a new SIM associated to the same phone number, known as multisim service.
\nThe API provides 2 operations:
\nPOST retrieve-date : Provides timestamp of latest SIM swap, if any, for a given phone number. If no swap has been performed, the API will return the SIM activation date (the timestamp of the first time that the sim connected to the network) by default, unless this is not possible due to local regulations preventing the safekeeping of the information for longer than the stated period of time. If this is the case, a null value will be returned.
POST check: Checks if SIM swap has been performed during a past period (defined in the request with 'maxAge' attribute) for a given phone number.
\nCAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document CAMARA-API-access-and-user-consent.md. Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nGSMA Mobile Connect Account Takeover Protection specification was used as source of input for this API. For more about Mobile Connect, please see Mobile Connect website.
\n(FAQs will be added in a later version of the documentation)
\nContact Support:
Email: awsgsma@u.com.my
Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"qosProfile\": \"QCI_1_voice\",\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": true,\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"sink\": \"https://endpoint.example.com/sink\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/device-qos","description":"Triggers a new provisioning in the operator to assign certain QoS Profile to certain device.
\nIf the provisioning is completed synchronously, the response will be 201 with status = AVAILABLE.
If the provisioning request is accepted but not yet completed, the response will be 201 with status = REQUESTED.
If the operator determines synchronously that the provisioning request cannot be fulfilled, the response will be 201 with status = UNAVAILABLE.
If the request includes the sink and sinkCredential properties, the client will receive a status-changed event with the outcome of the process. The event will be sent also for synchronous operations.
NOTES:
\nUNAVAILABLE, the QoD provisioning resource is not immediately released, but will get deleted automatically, at earliest 360 seconds after.This behavior allows clients which are not receiving notification events but are polling, to get the provisioning status information. Before a client can attempt to create a new QoD provisioning for the same device, they must release the provisioning resources with an explicit delete operation if not yet automatically deleted.
device parameter in the request (see \"Handling of device information\" within the API description for details).Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/device-qos/:provisioningId","description":"Querying for QoD provisioning resource information details
\nNOTES:
\nProvisioning ID that was obtained from the createProvision operation
\n","type":"text/plain"},"type":"any","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","key":"provisioningId"}]}},"response":[{"id":"d1381324-fcd7-4fc2-9433-97ad32ca027b","name":"PROVISIONING_AVAILABLE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"qosProfile\": \"QOS_L\",\n \"sink\": \"https://application-server.com/callback\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\",\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"accessTokenExpiresUtc\": \"2024-12-01T12:00:00Z\",\n \"accessTokenType\": \"bearer\"\n },\n \"provisioningId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"startedAt\": \"2024-05-12T17:32:01Z\",\n \"status\": \"AVAILABLE\"\n}"},{"id":"d13000d8-ec8a-4326-b45b-40ddff47866b","name":"PROVISIONING_UNAVAILABLE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"duration\": 86400,\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"203.0.113.0\",\n \"publicPort\": 59765\n }\n },\n \"qosProfile\": \"QOS_L\",\n \"sink\": \"https://application-server.com/callback\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\",\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"accessTokenExpiresUtc\": \"2024-12-01T12:00:00Z\",\n \"accessTokenType\": \"bearer\"\n },\n \"provisioningId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"startedAt\": \"2024-05-12T17:32:01Z\",\n \"status\": \"UNAVAILABLE\",\n \"statusInfo\": \"NETWORK_TERMINATED\"\n}"},{"id":"f5a5df60-3b18-4eab-a321-3a7273b55f37","name":"PROVISIONING_AVAILABLE_WITHOUT_DEVICE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"qosProfile\": \"QOS_M\",\n \"sink\": \"https://application-server.com/callback\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\",\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"accessTokenExpiresUtc\": \"2024-12-01T12:00:00Z\",\n \"accessTokenType\": \"bearer\"\n },\n \"provisioningId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"startedAt\": \"2024-05-12T17:32:01Z\",\n \"status\": \"AVAILABLE\"\n}"},{"id":"77338ed1-a9c2-46d3-b0bc-91e528e29132","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"58348e1c-6a01-41f1-80dd-150ace85ce74","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"7e36e573-3da2-445d-b3c7-16a83b291e80","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"efde8113-5468-495f-b9a1-df7e947014ae","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"0d797466-743a-44bf-8308-69552c22ac42","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"19453047-a67f-49d0-82ca-2c38edf25eeb","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"6ca5be91-8c5e-4c90-a5f7-6adcc0871ab8","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"76d1e741-dd24-4d8e-8c0e-a01357e46d5b","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"67ffadfe-78bb-45e0-972b-4b56a501e6f5","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"45de3e47-57a0-4ad0-92f9-8f1709876288","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Unknown server error. Typically a server bug.\"\n}"},{"id":"764fb81f-fbd4-4dd1-99fe-ed625e70a3b3","name":"Service unavailable","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"68e1393c-8c08-4711-b57c-203519da925a"},{"name":"Deletes a QoD provisioning","id":"cb4ec401-4652-41cb-bcb7-77b1109e0fc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/device-qos/:provisioningId","description":"Release resources related to QoS provisioning.
\nIf the notification callback is provided and the provisioning status was AVAILABLE, when the deletion is completed, the client will receive in addition to the response a PROVISIONING_STATUS_CHANGED event with
status as UNAVAILABLE andstatusInfo as DELETE_REQUESTED\nThere will be no notification event if the status was already UNAVAILABLE.NOTES:
\nProvisioning ID that was obtained from the createProvision operation
\n","type":"text/plain"},"type":"any","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","key":"provisioningId"}]}},"response":[{"id":"527214f2-ebe0-4839-aa17-50f52a5bb7a1","name":"Deletion request accepted to be processed. It applies for an async deletion process. `status` in the response will be `AVAILABLE` with `statusInfo` set to `DELETE_REQUESTED`.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"qosProfile\": \"QCI_1_voice\",\n \"provisioningId\": \"fa061b45-baf3-31c1-11b7-4ee9a2ba7434\",\n \"status\": \"AVAILABLE\",\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": 9681\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"sink\": \"https://endpoint.example.com/sink\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n },\n \"startedAt\": \"2024-06-01T12:00:00Z\",\n \"statusInfo\": \"DELETE_REQUESTED\"\n}"},{"id":"62dc3116-ee7a-448f-8fd7-9f70bfd8b749","name":"Provisioning deleted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":null},{"id":"5a173678-8455-4f6f-9bad-8177dd7d4b69","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"269053ab-cdcd-4438-86aa-3fe063b1561c","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"f0fd82e1-f45f-4765-a97f-085b25089a6d","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"b8d74d28-99a1-43e6-b01b-47ba9cb6d67a","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"e94edb62-1682-4e29-9aa1-d8f84fb0a96c","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"0be16dd4-6fd8-4390-8ab3-830ab786367f","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"2cc0eedb-1a20-4fb4-a196-25e8a2293184","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"a5c1b627-4995-4814-8833-b3bde72d3ec7","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"aa9dfcce-6d21-4827-98f1-262413bc11a4","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"de285dd8-caab-4762-9861-ed11ab9eb542","name":"Internal server error","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Unknown server error. Typically a server bug.\"\n}"},{"id":"8a5df6e4-e32f-445c-8827-37daa2d08bc0","name":"Service unavailable","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/device-qos/:provisioningId","host":["{{baseUrl}}"],"path":["device-qos",":provisioningId"],"variable":[{"key":"provisioningId","value":"ead3b87c-bb3d-6146-7c43-7335741d20b3","description":"Provisioning ID that was obtained from the createProvision operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"cb4ec401-4652-41cb-bcb7-77b1109e0fc3"}],"id":"054e88c9-df80-4fa8-b90b-6f2ddf20d2c1","_postman_id":"054e88c9-df80-4fa8-b90b-6f2ddf20d2c1","description":""},{"name":"retrieve-device-qos","item":[{"name":"Gets the QoD provisioning for a device","id":"7399bd81-b3de-49a1-8b42-a35d8e1d11c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 1241.9376836370354,\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve-device-qos","description":"Retrieves the QoD provisioning for a device.
\nNOTES:
\ndevice parameter in the request (see \"Handling of device information\" within the API description for details).The Quality-On-Demand (QoD) Provisioning API offers a programmable interface for developers to request the assignment of a certain QoS Profile to a certain device, indefinitely.
\nThis API sets up the configuration in the network so the requested QoS profile is applied to an specified device, at any time while the provisioning is available. The device traffic will be treated with a certain QoS profile by the network whenever the device is connected to the network, until the provisioning is deleted.
\nQoS profiles and QoS profile labels:
Latency, throughput or priority requirements of the application mapped to relevant QoS profile values. The set of QoS Profiles that a network operator is offering may be retrieved via the qos-profiles API (cf. https://github.com/camaraproject/QualityOnDemand/) or will be agreed during the onboarding with the API service provider.
Identifier for the device:
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the network operator for the device, at the request time. After the provisioning request is accepted, the device may get different IP addresses, but the provisioning will still apply to the device that was identified during the request process. Note: Network Access Identifier is defined for future use and will not be supported with v0.1 of the API.
Notification URL and token:
Developers may provide a callback URL (sink) on which notifications about all status change events (eg. provisioning termination) can be received from the service provider. This is an optional parameter. The notification will be sent as a CloudEvent compliant message. If sink is included, it is RECOMMENDED for the client to provide as well the sinkCredential property to protect the notification endpoint. In the current version,sinkCredential.credentialType MUST be set to ACCESSTOKEN if provided.
The API defines four operations:
\nAn operation to setup a new QoD provisioning for a given device.
\nAn operation to get the information about a specific QoD provisioning, identified by its provisioningId.
An operation to get the QoD provisioning for a given device.
\nAn operation to terminate a QoD provisioning, identified by its provisioningId.
The \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.In multi-SIM scenarios where more than one mobile device is associated with a phone number (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify the device to which the QoS provisioning should apply from that phone number. If the phone number is used as the device identifier when provisioning in a multi-SIM scenario, the API may respond with an error, apply the provisioning to all devices in the multi-SIM group, or apply the provisioning to a single device in the multi-SIM group which may not be the intended device.
\nPossible solutions in such a scenario include:
\nUsing the authorisation code flow to obtain an access token, which will automatically identify the intended device
\nIdentifying the intended device from a unique identifier for that device, such as its source IP address and port
\nCheck with the SIM provider whether a unique \"secondary\" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available.
\nCorrelation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 4682,\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"name\": \"QCI_1_voice\",\n \"status\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve-qos-profiles","description":"Returns all QoS Profiles that match the given criteria.\nNOTES:
\nCorrelation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/qos-profiles/:name","description":"Returns a QoS Profile that matches the given name.
\nThe access token may be either a 2-legged or 3-legged access token. If the access token is 3-legged, a QoS Profile is only returned if available to all end users associated with the access token.
\n","urlObject":{"path":["qos-profiles",":name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"c0f1964b-2946-442f-b56d-ed753e865dd0","description":{"content":"Qos Profile name
\n","type":"text/plain"},"type":"any","value":"QCI_1_voice","key":"name"}]}},"response":[{"id":"69aff9c1-859d-453a-aed9-9d4b9e1a4518","name":"Contains information about QoS Profiles","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"QCI_1_voice\",\n \"status\": \"DEPRECATED\",\n \"description\": \"QoS profile for video streaming\",\n \"targetMinUpstreamRate\": {\n \"value\": 10,\n \"unit\": \"kbps\"\n },\n \"maxUpstreamRate\": {\n \"value\": 10,\n \"unit\": \"kbps\"\n },\n \"maxUpstreamBurstRate\": {\n \"value\": 10,\n \"unit\": \"bps\"\n },\n \"targetMinDownstreamRate\": {\n \"value\": 10,\n \"unit\": \"Tbps\"\n },\n \"maxDownstreamRate\": {\n \"value\": 10,\n \"unit\": \"bps\"\n },\n \"maxDownstreamBurstRate\": {\n \"value\": 10,\n \"unit\": \"Gbps\"\n },\n \"minDuration\": {\n \"value\": 12,\n \"unit\": \"Days\"\n },\n \"maxDuration\": {\n \"value\": 12,\n \"unit\": \"Nanoseconds\"\n },\n \"priority\": 20,\n \"packetDelayBudget\": {\n \"value\": 12,\n \"unit\": \"Hours\"\n },\n \"jitter\": {\n \"value\": 12,\n \"unit\": \"Seconds\"\n },\n \"packetErrorLossRate\": 3\n}"},{"id":"d16daa55-3f88-459d-8b27-f49667a74af9","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"cdb6c524-7086-4fa5-b53f-417e12fa0aaf","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"d4124aa0-1feb-4de9-8d90-d511e3a37ccb","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"d486cccd-0471-4614-9b4e-dbcddb14e87e","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"1ce30692-9b03-4970-9853-80d961324f5b","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"9afcf726-aadc-4542-8f17-efa6a0b27024","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"090b2422-5762-4d58-b66e-f92d9aba14db","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"a744518f-c5b6-4f14-85a0-24f2b55afd2b","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"7facca79-f398-4ef1-96d0-d6216d78c1ab","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"5e153e5c-8883-41d2-ac4e-b6b2e2f0fcef","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error: ...\"\n}"},{"id":"ec3bcaf4-2f4c-49f6-86d3-4b299b1ffd8a","name":"Service Unavailable","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/qos-profiles/:name","host":["{{baseUrl}}"],"path":["qos-profiles",":name"],"variable":[{"key":"name","value":"QCI_1_voice","description":"Qos Profile name"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"2753d94f-9f0c-4b52-9b0c-6a96f5829a2c"}],"id":"cce5e5a6-6494-4ea2-9754-0676f6539b59","_postman_id":"cce5e5a6-6494-4ea2-9754-0676f6539b59","description":""}],"id":"0e74cdc7-b540-4eb2-9f1d-3d9d816f68b1","description":"The QoS Profiles API allows the discovery of Quality of Service (QoS) profiles and its characteristics.
\nQoS Profiles are used in conjunction with other Quality-On-Demand APIs, to offer the application developers the capability to request for stable latency (reduced jitter) or throughput for some specified application data flows between application clients (within a user device) and Application Servers (backend services). The developer has a pre-defined set of Quality of Service (QoS) profiles which they could choose from depending on their latency or throughput requirements. The QoS profiles are defined by the network operator and are mapped to the connectivity characteristics of the network.
\nThe QoS Profiles API provides the following functionality:
\nDiscovery of all QoS profiles offered by the network operator
\nRetrieve the characteristics of a specific QoS profile by name
\nHow QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.In multi-SIM scenarios where more than one mobile device is associated with a phone number (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify a single device from that phone number. When filtering QoS profiles by device in such scenarios, one of the following options should be used:
\nUse the authorisation code flow to obtain a 3-legged access token, which will automatically identify the intended device
\nIdentify the intended device from a unique identifier for that device, such as its source IP address and port
\nCheck with the SIM provider whether a unique \"secondary\" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available
\n(FAQs will be added in a later version of the documentation)
\n","_postman_id":"0e74cdc7-b540-4eb2-9f1d-3d9d816f68b1"},{"name":"Quality-On-Demand","item":[{"name":"sessions","item":[{"name":"Creates a new session","id":"dbb5be1a-d904-45e2-a571-3e87b21d3a3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"applicationServer\": {\n \"ipv4Address\": \"198.51.100.0/24\",\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"qosProfile\": \"QCI_1_voice\",\n \"duration\": 3600,\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": true,\n \"privateAddress\": 94.68906229483265\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"devicePorts\": {\n \"ranges\": [\n {\n \"from\": 5010,\n \"to\": 5020\n }\n ],\n \"ports\": [\n 5060,\n 5070\n ]\n },\n \"applicationServerPorts\": {\n \"ranges\": [\n {\n \"from\": 5010,\n \"to\": 5020\n }\n ],\n \"ports\": [\n 5060,\n 5070\n ]\n },\n \"sink\": \"https://endpoint.example.com/sink\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/sessions","description":"Create QoS Session to manage latency/throughput priorities
\nIf the qosStatus in the API response is \"AVAILABLE\" and a notification callback is provided the client will receive in addition to the response a\nQOS_STATUS_CHANGED event notification with qosStatus as AVAILABLE.
If the qosStatus in the API response is REQUESTED, the client will receive either
QOS_STATUS_CHANGED event notification with qosStatus as AVAILABLE after the network notifies that it has created the requested session, orQOS_STATUS_CHANGED event notification with qosStatus as UNAVAILABLE and statusInfo as NETWORK_TERMINATED after the network notifies that it has failed to provide the requested session.A QOS_STATUS_CHANGED event notification with qosStatus as UNAVAILABLE will also be send if the network terminates the session before the requested duration expired
NOTES:
\nIn case of a QOS_STATUS_CHANGED event with qosStatus as UNAVAILABLE and statusInfo as NETWORK_TERMINATED the resources of the QoS session are not directly released, but will get deleted automatically at earliest 360 seconds after the event.
This behavior allows clients which are not receiving notification events but are polling to get the session information with the qosStatus UNAVAILABLE and statusInfo NETWORK_TERMINATED. Before a client can attempt to create a new QoD session for the same device and flow period they must release the session resources with an explicit delete operation if not yet automatically deleted.
The access token may be either 2-legged or 3-legged.
\ndevice parameter in the request (see \"Handling of device information\" within the API description for details).Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/sessions/:sessionId","description":"Querying for QoS session resource information details
\nNOTES:
\nSession ID that was obtained from the createSession operation
\n","type":"text/plain"},"type":"any","value":"1bffff16-a571-8f3a-603e-df898785471e","key":"sessionId"}]}},"response":[{"id":"d90b3719-1d72-45f6-ad75-dff30640a69a","name":"SESSION_AVAILABLE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"duration\": 3600,\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"203.0.113.0\",\n \"publicPort\": 59765\n }\n },\n \"applicationServer\": {\n \"ipv4Address\": \"198.51.100.0/24\"\n },\n \"qosProfile\": \"QOS_L\",\n \"sink\": \"https://application-server.com/notifications\",\n \"sessionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"startedAt\": \"2024-06-01T12:00:00Z\",\n \"expiresAt\": \"2024-06-01T13:00:00Z\",\n \"qosStatus\": \"AVAILABLE\"\n}"},{"id":"ea829f13-1f3e-4e95-8496-02d60baf6499","name":"SESSION_UNAVAILABLE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"duration\": 2428,\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"203.0.113.0\",\n \"publicPort\": 59765\n }\n },\n \"applicationServer\": {\n \"ipv4Address\": \"198.51.100.0/24\"\n },\n \"qosProfile\": \"QOS_L\",\n \"sink\": \"https://application-server.com/notifications\",\n \"sessionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"startedAt\": \"2024-06-01T12:00:00Z\",\n \"expiresAt\": \"2024-06-01T12:40:28Z\",\n \"qosStatus\": \"UNAVAILABLE\",\n \"statusInfo\": \"NETWORK_TERMINATED\"\n}"},{"id":"419c87fd-756f-42ca-93fd-07f0e3fc16e0","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"bcaf54a1-54f1-4e1d-aa20-06dff23e0eb5","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"d443cb55-698e-4185-9abd-7525291b37a1","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"1df40edd-aa33-41ea-b0be-000b90a9875e","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"f26295de-551f-4d67-9361-63fb6bff40cf","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"02284341-0a2a-43ce-9bc2-32631be385fe","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"ba750f05-2d12-43e1-bc3d-7f012d728c74","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"a333c175-ee7c-45ad-b6ea-5f89c696b43d","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"d96e43c0-e076-445b-ba12-5ea44b1b6f07","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"5ef01573-58b4-414a-a81f-37110cc0fd51","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error: ...\"\n}"},{"id":"cc6fdc75-5f95-46e8-af0c-7028dda75f79","name":"Service Unavailable","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"d00fe171-4a2b-46ce-a629-6aad9855fff5"},{"name":"Delete a QoS session","id":"71cd6ffc-eb80-4402-a182-ee3b19906fe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/sessions/:sessionId","description":"Release resources related to QoS session
\nIf the notification callback is provided and the qosStatus of the session was AVAILABLE the client will receive in addition to the response a QOS_STATUS_CHANGED event with
qosStatus as UNAVAILABLE andstatusInfo as DELETE_REQUESTED\nThere will be no notification event if the qosStatus was already UNAVAILABLE.NOTES:
\nSession ID that was obtained from the createSession operation
\n","type":"text/plain"},"type":"any","value":"1bffff16-a571-8f3a-603e-df898785471e","key":"sessionId"}]}},"response":[{"id":"b4b6090c-a0df-4a63-b4c7-18aa6dfe31ef","name":"Session deleted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":null},{"id":"a7f18d8e-e409-46d4-8840-7d8199c674de","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"fbd8d508-cf9a-49fb-818b-fd1862405f8e","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"26ef2efe-fafc-488f-8d78-015d563c76e5","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"f431baef-172d-4a35-9367-4fbed375083b","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"20550002-ec79-467c-b308-da8305f7761c","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"f235c6d1-6f4f-44fd-807d-18c24e07b20e","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"81abe20d-aa19-4ac4-93bf-22a1939bb958","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"02ee835c-05e8-4a82-9314-c6818cc122d0","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"8cd71ed4-bfc2-40d1-8e2a-f52ac5e7d284","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"a058920d-b2e7-4a66-95d9-76085920b5f6","name":"Internal server error","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error: ...\"\n}"},{"id":"f07e84b8-5114-4542-ada6-08c8cd2e4933","name":"Service Unavailable","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/sessions/:sessionId","host":["{{baseUrl}}"],"path":["sessions",":sessionId"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"71cd6ffc-eb80-4402-a182-ee3b19906fe3"}],"id":"3f173901-4ffc-4171-b013-c33f34b459d9","_postman_id":"3f173901-4ffc-4171-b013-c33f34b459d9","description":""},{"name":"sessions/{sessionId}/extend","item":[{"name":"Extend the duration of an active session","id":"81db1d6b-5848-4cb6-993e-bd6abbe58a67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/sessions/:sessionId/extend","description":"Extend the overall session duration of an active QoS session (with qosStatus = AVAILABLE).\nThe overall duration of the QoS session, including the additional extended duration, shall not exceed the maximum duration limit fixed for the QoS Profile. If the current duration plus the value of requestedAdditionalDuration exceeds the maximum limit, the new overall duration shall be capped to the maximum value allowed.\nAn example: For a QoS profile limited to a maxDuration of 50,000 seconds, a QoD session was originally created with duration 30,000 seconds. Before the session expires, the developer requests to extend the session by another 30,000 seconds:
NOTES:
\nSession ID that was obtained from the createSession operation
\n","type":"text/plain"},"type":"any","value":"1bffff16-a571-8f3a-603e-df898785471e","key":"sessionId"}]}},"response":[{"id":"1bb9f77b-38ce-4d23-aa9c-cf556fc488d2","name":"Contains information about active session","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"applicationServer\": {\n \"ipv4Address\": \"198.51.100.0/24\",\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"qosProfile\": \"QCI_1_voice\",\n \"sessionId\": \"3c9fe81b-18f3-222f-be55-51bdeebbe9ad\",\n \"duration\": 3600,\n \"qosStatus\": \"REQUESTED\",\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"privateAddress\": 2269.633653233636\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"devicePorts\": {\n \"ranges\": [\n {\n \"from\": 5010,\n \"to\": 5020\n }\n ],\n \"ports\": [\n 5060,\n 5070\n ]\n },\n \"applicationServerPorts\": {\n \"ranges\": [\n {\n \"from\": 5010,\n \"to\": 5020\n }\n ],\n \"ports\": [\n 5060,\n 5070\n ]\n },\n \"sink\": \"https://endpoint.example.com/sink\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n },\n \"startedAt\": \"2024-06-01T12:00:00Z\",\n \"expiresAt\": \"2024-06-01T13:00:00Z\",\n \"statusInfo\": \"NETWORK_TERMINATED\"\n}"},{"id":"20767261-aed0-46e0-a31f-d9a8f0d54bce","name":"GENERIC_400_INVALID_ARGUMENT","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"b3919b2b-7973-4312-8753-709ba3c02cd2","name":"GENERIC_400_OUT_OF_RANGE","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"ae698ac3-3e0f-4a5c-b462-ecf94950e101","name":"DurationOutOfRangeForQoSProfile","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"QUALITY_ON_DEMAND.DURATION_OUT_OF_RANGE\",\n \"message\": \"The requested duration is out of the allowed range for the specific QoS profile\"\n}"},{"id":"60dd26f5-7e78-43dd-8169-8c180a8184d6","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"71f96aef-10e2-4f06-9810-918fa8496a47","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"7e967fe1-3a0b-4fab-ab90-e21590b52a2f","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"a6c3ceb3-d859-4643-911c-adb4086c947d","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"36e897a0-413a-47aa-811a-2235d0345145","name":"Not found","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"811b2391-1eeb-438c-93c7-dd7848555221","name":"Conflict","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 409,\n \"code\": \"QUALITY_ON_DEMAND.SESSION_EXTENSION_NOT_ALLOWED\",\n \"message\": \"Extending the session duration is not allowed in the current state ({qosStatus}). The session must be in the AVAILABLE state.\"\n}"},{"id":"a3e34e7b-9239-4b5e-8c29-2a58bc1873d9","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"63a83db6-4a45-4760-b3fc-ea77a4683d02","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"c7bd8c6b-8759-47b0-b98a-920dbf6c6503","name":"Internal server error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error: ...\"\n}"},{"id":"d19da623-e75d-4ac6-ae4c-4e3fc6969216","name":"Service Unavailable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requestedAdditionalDuration\": 1800\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/sessions/:sessionId/extend","host":["{{baseUrl}}"],"path":["sessions",":sessionId","extend"],"variable":[{"key":"sessionId","value":"1bffff16-a571-8f3a-603e-df898785471e","description":"Session ID that was obtained from the createSession operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"81db1d6b-5848-4cb6-993e-bd6abbe58a67"}],"id":"921aba06-a854-477c-ae6a-fe3b434e7f6f","_postman_id":"921aba06-a854-477c-ae6a-fe3b434e7f6f","description":""},{"name":"retrieve-sessions","item":[{"name":"Get QoS session information for a device","id":"fa1a4348-b10e-48b1-b552-8a1491d90742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 1858,\n \"publicPort\": 3463.779855340934\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve-sessions","description":"Querying for QoS session resource information details for a device
\nNOTES:
\ndevice parameter in the request (see \"Handling of device information\" within the API description for details).The Quality-On-Demand (QoD) API provides programmable interface for developers and other users (capabilities consumers) to request stable latency or throughput managed by Telco networks without the necessity to have an in-depth knowledge of the 4G/5G system or the overall complexity of the Telecom Systems.
\nIndustrial (IoT), VR/Gaming, live video streaming, autonomous driving and many other scenarios demand network communication quality and are sensitive to any change in transmission conditions. Being able to request a stable latency (reduced jitter) or prioritized throughput from the network can improve user experience substantially.
\nThe QoD API offers the application developers the capability to request for stable latency (reduced jitter) or throughput for some specified application data flows between application clients (within a user device) and Application Servers (backend services). The developer has a pre-defined set of Quality of Service (QoS) profiles which they could choose from depending on their latency or throughput requirements.
\n![\"QoD](\"https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/documentation/API_documentation/resources/QoD_latency_overview.PNG\")
\n\nThe usage of the API is based on QoS session resources, which can be created (based on available QoS profiles), queried and deleted. The deletion of a requested session can be triggered by the API consumer or can be triggered automatically once the QoS session has reached its limit.
\nQOD service endpoint:
The URL pointing to the RESTful resource of the QoD API.
Authentication:
Security access keys such as OAuth 2.0 client credentials used by client applications to invoke the QoD API.
QoS profiles and QoS profile labels:
Latency, throughput or priority requirements of the application mapped to relevant QoS profile values. The set of QoS Profiles that a network operator is offering may be retrieved via the qos-profiles API (cf. https://github.com/camaraproject/QualityOnDemand/) or will be agreed during the onboarding with the API service provider.
Identifier for the device:
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. Note: Network Access Identifier is defined for future use and will not be supported with v0.11.0 of the API.
Identifier for the application server:
IPv4 and/or IPv6 address of the application server (application backend)
App-Flow (between the application client and application server):
The precise application data flow the developer wants to prioritize and have stable latency or throughput for. This flow is in the current API version determined by the identifiers used for the device and the application server. And it can be further elaborated with details such as ports or port-ranges. Future version of the API might allow more detailed flow identification features.
Duration:
Duration (in seconds) for which the QoS session (between application client and application server) should be created. Limits for session duration can be set by the implementation for the QoS profile. The user may request a termination before its expiration.
sink) on which notifications about all status change events (eg. provisioning termination) can be received from the service provider. This is an optional parameter. The notification will be sent as a CloudEvent compliant message.sink is included, it is RECOMMENDED for the client to provide as well the sinkCredential property to protect the notification endpoint. In the current version,sinkCredential.credentialType MUST be set to ACCESSTOKEN if provided.The usage of the QoD API is based on QoS profile classes and parameters which define App-Flows.
Based on the API, QoS session resources can be created, queried, and deleted. Once an offered QoS profile class is requested, application users get a prioritized service with stable latency or throughput even in the case of congestion. The QoD API has the following characteristics:
A specified App-Flow is prioritized to ensure stable latency or throughput for that flow.
\nThe prioritized App-Flow is described by providing information such as device IP address (or other device identifier) & application server IP addresses and port/port-ranges.
\nThe developer specifies the duration for which they need the prioritized App-flow.
\nStable latency or throughput is requested by selecting from the list of QoS profiles made available by the service provider (e.g. QOS_E) to map latency and throughput requirements.
\nThe developer can optionally also specify callback URL (sink param) on which notifications for the session can be sent.
Following diagram shows the interaction between different components
\n![\"QoD](\"https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/documentation/API_documentation/resources/QoD_details.PNG\")
\n\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.In multi-SIM scenarios where more than one mobile device is associated with a phone number (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify the device to which the enhanced QoS profile should apply from that phone number. If the phone number is used as the device identifier when creating a QoS session in a multi-SIM scenario, the API may respond with an error, apply the enhanced QoS profile to all devices in the multi-SIM group, or apply the enhanced QoS profile to a single device in the multi-SIM group which may not be the intended device.
\nPossible solutions in such a scenario include:
\nUsing the authorisation code flow to obtain an access token, which will automatically identify the intended device
\nIdentifying the intended device from a unique identifier for that device, such as its source IP address and port
\nCheck with the SIM provider whether a unique \"secondary\" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available
\n(FAQs will be added in a later version of the documentation)
\n","_postman_id":"17b3bd32-d479-4bf9-b25d-c8e49859fa53"}],"id":"0d3c3b47-ab9a-4e66-b7f1-8821a8fd5d63","description":"The GSMA CAMARA Quality-On-Demand (QoD) API provides a programmable interface for developers to request stable latency or prioritized throughput managed by networks, abstracting the complexity of underlying network technologies like mobile, fiber, cable, and other broadband networks. The API enables QoS session management, allowing developers to create, query, and delete QoS session resources based on predefined QoS profiles tailored to different latency and throughput needs, with support for status change notifications via callbacks. It's particularly valuable for applications requiring high-quality network communication, including industrial IoT, live video streaming, autonomous driving, telemedicine, VoIP services, and enterprise applications. The API is part of the GSMA Open Gateway initiative and allows developers to focus on enhancing user experiences without needing to understand the complex network infrastructure behind them.
\n","_postman_id":"0d3c3b47-ab9a-4e66-b7f1-8821a8fd5d63"},{"name":"Device Location API","item":[{"name":"subscriptions","item":[{"name":"Create a geofencing subscription for a device","id":"904358cc-d2e3-46df-80ae-f70212822358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions","description":"Create a subscription for a device to receive notifications when a device enters or exits a specified area
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"4439f6c8-5782-4ad2-9832-ff80cc2d67f6","name":"Created (Successful creation of subscription)","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 6255,\n \"publicPort\": 9801\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"1119920371\",\n \"startsAt\": \"1981-07-21T14:19:57.777Z\",\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n },\n \"expiresAt\": \"1980-05-19T14:33:31.590Z\",\n \"status\": \"INACTIVE\"\n}"},{"id":"c3191722-81f6-4237-8a30-6a1c5e621ee0","name":"Request accepted to be processed. It applies for async creation process.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"qs15-h556-rt89-1298\"\n}"},{"id":"d4af4515-c1f1-42b3-a00c-ae84bcc33d6a","name":"InvalidArgument","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"d22027b9-3d66-475f-a4b6-820c7eef21f1","name":"InvalidProtocol","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_PROTOCOL\",\n \"message\": \"Only HTTP is supported\"\n}"},{"id":"71cfcae6-6a4d-4d50-8563-c481706dfdf5","name":"InvalidCredential","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_CREDENTIAL\",\n \"message\": \"Only Access token is supported\"\n}"},{"id":"d9654f99-0b60-4355-b3b6-3993fa9e0629","name":"InvalidToken","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_TOKEN\",\n \"message\": \"Only bearer token is supported\"\n}"},{"id":"8145e1ac-f93f-4e68-a458-4d53b901499c","name":"Authentication problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"3e4beacd-3316-4b51-955a-73135ef3b501","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"8ef54b12-9a66-4c9e-b4f0-62088fdead61","name":"PermissionDenied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED\",\n \"message\": \"Multi event types subscription not managed\"\n}"},{"id":"6307d80d-f499-4379-b69b-c8b4bca867e5","name":"DeviceIdentifierMismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"Provided device identifiers are not consistent.\"\n}"},{"id":"12df9f67-8c6a-488f-9dbe-fffb166bbcee","name":"DeviceNotApplicable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The service is not available for the provided device.\"\n}"},{"id":"44f70b44-cc08-4617-a982-a47f96ff925c","name":"AreaNotCovered","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"AREA_NOT_COVERED\",\n \"message\": \"The specified area cannot be covered or is too small to be valid\"\n}"},{"id":"8a66d3e9-abf6-4af3-b715-92d99a91df53","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"23cfeeb3-30fb-4a84-8489-2171a7efd3f1","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"2c4de8ed-ec80-4e25-bbbc-8de3f5de7799","name":"Server error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"51c20d84-e5f2-4337-a79d-ffd9b6c22aa6","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"HTTP\",\n \"sink\": \"https://notificationSendServer12.supertelco.com\",\n \"types\": [\n \"org.camaraproject.geofencing-subscriptions.v0.area-entered\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+12345678912\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 2000\n }\n },\n \"initialEvent\": true,\n \"subscriptionMaxEvents\": 10,\n \"subscriptionExpireTime\": \"2024-03-22T05:40:58.469Z\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"904358cc-d2e3-46df-80ae-f70212822358"},{"name":"Retrieve a list of geofencing event subscription","id":"c122057a-2a8e-44df-93da-e1ea2030fc2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions","description":"Retrieve a list of geofencing event subscription(s)
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b7113acb-e492-46c4-b78b-4ec31aaf965c","name":"List of event subscription details","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 5907,\n \"privateAddress\": 1576.6026756135875\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": false\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"1119920371\",\n \"startsAt\": \"1954-03-11T17:02:49.136Z\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\"\n },\n \"expiresAt\": \"1981-07-11T04:07:29.829Z\",\n \"status\": \"DELETED\"\n },\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 6573.78642206941,\n \"privateAddress\": 1732\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": false\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"1119920371\",\n \"startsAt\": \"1992-01-09T03:46:51.261Z\",\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n },\n \"expiresAt\": \"1965-07-02T09:51:07.898Z\",\n \"status\": \"INACTIVE\"\n }\n]"},{"id":"5f11ebca-88cd-4dfa-9df8-aed9244061db","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"b293cb04-2131-4e4b-aa64-cdbf3c82e67c","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"5eb036f4-c86f-4190-8596-37c882f390b6","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"5d7e2f1a-06ef-47bb-b3c4-bcda0f2b2ae6","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"7752983c-d2df-47d8-a668-5c2b1d90acf4","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"29b022b5-35ee-4502-86c1-46c737f4f2c3","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"9b2d3596-646a-49f9-baca-f249bb409567","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"c122057a-2a8e-44df-93da-e1ea2030fc2f"}],"id":"424a522a-642b-4c3e-a006-1f5d97dd8b69","description":"API to create, retrieve and delete event subscriptions to realize geofencing for a user device.
\nWith this API, API consumers can create subscriptions for their devices to receive notifications when a device enters or exits a specified area.
\nThe area provided in the request is described by a circle determined by coordinates (latitude and longitude) and an accuracy defined by the radius.
\nUpon successfully creating a subscription, the API will provide an Event Subscription ID, and it will indicate the subscription's expiration date.
\nIf the geofencing-state of a device changes, the event subscriber will be notified back to the provided Notification-Url given by the subscription-request.
\nDevice geofencing API could be useful in scenarios such as:
\nTracking devices for Presetting of Home-Settings
\nTracking of logistics
\nDevice: A device refers to any physical entity that can connect to a network and participate in network communication.
\nArea: It specifies the geographical surface which a device is planned to enter or exit.
\nThe API exposes following capabilities:
\nThese endpoints allow to manage event subscription on geofencing device location event.
\nThe CAMARA subscription model is detailed in the CAMARA API design guideline document and follows CloudEvents specification.
\nIt is mandatory in the subscription to provide the event type for which the client would like to subscribe.
Following event types are managed for this API:
org.camaraproject.geofencing-subscriptions.v0.area-entered - Event triggered when the device enters the given area
org.camaraproject.geofencing-subscriptions.v0.area-left - Event triggered when the device leaves the given area
Note: Additionally to these list, org.camaraproject.geofencing-subscriptions.v0.subscription-ends notification type is sent when the subscription ends.
This notification does not require dedicated subscription.
It is used when:
\nthe subscription expire time (optionally set by the requester) has been reached
\nthe maximum number of subscription events (optionally set by the requester) has been reached
\nthe subscription was deleted by the requester
\nthe Access Token sinkCredential (optionally set by the requester) expiration time has been reached
the API server has to stop sending notification prematurely
\nthe specified geofence-area cannot be covered or is too small to be managed
This endpoint describes the event notification received on subscription listener side when the event occurred.
As for subscription, detailed description of the event notification is provided in the CAMARA API design guideline document.
WARNING_: This callback endpoint must be exposed on the consumer side as _POST /{$request.body#/sink}__.
Developers may provide a callback URL on which notifications regarding geofencing can be received from the service provider.
If an event occurs the application will send events to the provided webhook - 'sink'.
The \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\n(FAQs will be added in a later version of the documentation)
\n","_postman_id":"424a522a-642b-4c3e-a006-1f5d97dd8b69"},{"name":"retrieve","item":[{"name":"Execute location retrieval for a user equipment","id":"0df27c30-0fec-494c-90c6-f5092093af0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve","description":"Retrieve the area where a certain user device is localized.
\n","urlObject":{"path":["retrieve"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"88d20eb4-a04a-4f3f-bc59-3184a966c88a","name":"LOCATION_CIRCLE","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastLocationTime\": \"2023-10-17T13:18:23.682Z\",\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 45.754114,\n \"longitude\": 4.860374\n },\n \"radius\": 800\n }\n}"},{"id":"772c2c7f-c74e-43ae-b0c2-18f1848b076d","name":"LOCATION_POLYGON","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastLocationTime\": \"2023-10-17T13:18:23.682Z\",\n \"area\": {\n \"areaType\": \"POLYGON\",\n \"boundary\": [\n {\n \"latitude\": 45.754114,\n \"longitude\": 4.860374\n },\n {\n \"latitude\": 45.753845,\n \"longitude\": 4.863185\n },\n {\n \"latitude\": 45.75249,\n \"longitude\": 4.861876\n },\n {\n \"latitude\": 45.751224,\n \"longitude\": 4.861125\n },\n {\n \"latitude\": 45.751442,\n \"longitude\": 4.859827\n }\n ]\n }\n}"},{"id":"6dd973d1-4e22-4301-aff7-25d8f05083db","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastLocationTime\": \"2023-10-17T13:18:23.682Z\",\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 45.754114,\n \"longitude\": 4.860374\n },\n \"radius\": 800\n }\n}"},{"id":"fc640098-65f6-4a3b-9541-8ef02daf9a4d","name":"Generic Invalid Argument","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"9ebdb827-b87e-4c02-ad19-ac4bef6d429b","name":"Generic Out of Range","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"85813888-ad57-48ed-8e0e-a854ea7c965f","name":"GENERIC_400_MAX_AGE_NOT_SATISFIABLE","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"LOCATION_RETRIEVAL.MAXAGE_INVALID_ARGUMENT\",\n \"message\": \"maxAge threshold cannot be satisfied\"\n}"},{"id":"eab6ad50-fff1-44c3-9ab3-cc1b048ce0a8","name":"Generic Unauthenticated","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"cf1fdc01-1e54-4c01-97e2-c71b1419116e","name":"Generic Authentication Required","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"4c58104f-ec90-4454-aa6e-7640b340b496","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"5a13d41e-6a63-40c4-8ec1-859e47fb8a36","name":"Generic Permission Denied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"b6a8bff8-5fa2-4824-8cb0-d6ad7d969f87","name":"Invalid access token context","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"bb399ed9-b709-45d4-9df9-41f092cb79a3","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"9fc6b09a-27d6-43d5-88d2-8e0df09b5a5b","name":"The location server is not able to locate the device","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"LOCATION_RETRIEVAL.DEVICE_NOT_FOUND\",\n \"message\": \"The location server is not able to locate the mobile\"\n}"},{"id":"9bbda4de-95c8-4f7f-ba64-d05b12ee47ca","name":"Some identifier cannot be matched to a device","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"DEVICE_NOT_FOUND\",\n \"message\": \"No device found for a provided identifier\"\n}"},{"id":"884c5817-f4a7-4159-a447-afae5964cc09","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"LOCATION_RETRIEVAL.DEVICE_NOT_FOUND\",\n \"message\": \"The location server is not able to locate the mobile\"\n}"},{"id":"7e5b8c2d-643c-491b-916e-e9e009d06d87","name":"Unable to provide expected frehsness","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE\",\n \"message\": \"Unable to provide expected freshness for location\"\n}"},{"id":"0861eaed-13a4-42dd-939c-37ccc418b66c","name":"Unprocessable entity","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNPROCESSABLE_ENTITY\",\n \"message\": \"Value not acceptable: ...\"\n}"},{"id":"ca06f0c0-05f5-4a6c-8817-d8b8108ccb7a","name":"Service not applicable to the device","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The device is not applicable for the requested operation\"\n}"},{"id":"72459ecf-c16d-462a-9237-fb641a4fd66c","name":"Device identifiers mismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"The provided device identifiers do not match the same device\"\n}"},{"id":"7a584d28-41ce-494e-8ca2-6da661be7cf4","name":"None of the provided device identifiers is supported by the implementation","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNSUPPORTED_DEVICE_IDENTIFIERS\",\n \"message\": \"Supported device supported are: ...\"\n}"},{"id":"21f9ad81-0c00-4f07-b7f5-77208790f767","name":"No identifier provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNIDENTIFIABLE_DEVICE\",\n \"message\": \"A device must be provided\"\n}"},{"id":"d1b78a04-9a0d-4e46-b969-5717473736a7","name":"Generic Internal","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"ba3dd3d9-e7e7-46c4-8a61-c130ea0d0fe8","name":"IPv4 address without maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"95f8403c-f190-46db-9991-6b0f834c937b","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"cdb26e3c-331f-4b9c-8fab-c015664131c0","name":"Generic Unavailable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"},{"id":"6779a62c-fc5a-4ae1-8f34-636126346659","name":"IPv4 address without maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"},{"id":"5aa3f972-b962-465b-bbc2-01fcea7472ad","name":"Device not provided, only maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"0df27c30-0fec-494c-90c6-f5092093af0d"}],"id":"9084fc4f-67eb-4652-9204-77ea11c37336","description":"This API provides the ability to retrieve a device location.
\nWith this API, API consumers can retrieve the area where a certain user device is localized.
The area provided in the response could be described:
by a circle determined by coordinates (latitude and longitude) and a radius.
\nby a simple polygon delimited by segments connecting consecutively an array of coordinates (points). The last point connects to the first point to delimit a closed shape bounded with straight sides.
\nThe retrieved shape depends on the network conditions at the device's location and any of the supported shapes could be received.
\nThe requester could optionally ask for a freshness of the localization information by providing a maxAge (\"I want a location not older than 600 seconds\").
The result accuracy depends on the network's ability and accuracy to locate the device.
\nAdditionally to location information, the answer will also provide indication about the location time.
\nLocation retrieval API could be useful in scenarios such as:
\nFraud protection to ensure a given user is located in the region, country or location authorized for financial transactions
\nVerify the GPS coordinates reported by the app on a device to ensure the GPS was not faked e.g. for content delivery with regional restrictions
\nContextual-based advertising, to trigger advertising after verifying the device is in the area of interest
\nSmart Mobility (Vehicle/bikes renting): obtain the location of a vehicle/bike to guarantee they are rented correctly
\nNote: Location is in most jurisdictions considered to be sensitive data and thereby consent by device owner/user must be verified before providing it to the developer.
\nDevice: A device refers to any physical entity that can connect to a network and participate in network communication.
\nArea: It specifies the geographical surface where a device may be physically located.
\nMax Age: Maximum age of the location information which is accepted for the location retrieval (in seconds).
\nAbsence of maxAge means that \"any age\" is acceptable for the client. In other words, this is like maxAge=infinite. The system will return lastLocationTime in the response. If the system is not able to provide location, an error 404 with code LOCATION_RETRIEVAL.DEVICE_NOT_FOUND is sent back.
maxAge=0 means that a fresh calculation is requested by the client. If the system is not able to provide the fresh location, an error 422 with code LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE is sent back.
Last Location Time : Last date and time when the device was localized.
\nThe API exposes a single endpoint/operation:
\n/retrieve : Retrieve where the device is localized.
The operation returns:
a localization defined either as a circle, with the center specified by the latitude and longitude, and a radius for answer accuracy, or as polygon defined by the array of points delimiting its boundary.
\na timestamp with the location information freshness.
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.(FAQs will be added in a later version of the documentation)
\n","_postman_id":"9084fc4f-67eb-4652-9204-77ea11c37336"},{"name":"verify","item":[{"name":"Verify the location of a device","id":"516fb192-1b15-473b-9505-5d61fbaec1b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify","description":"Verify whether the location of a device is within a requested area. The operation returns a verification result and, optionally, a match rate estimation for the location verification in percent.
\n","urlObject":{"path":["verify"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f121c754-7017-4c58-b235-2389adcfa4d9","name":"Match","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"verificationResult\": \"TRUE\",\n \"lastLocationTime\": \"2023-09-07T10:40:52Z\"\n}"},{"id":"46d67690-7e1a-4a76-bea2-eec390f8b010","name":"No match","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"verificationResult\": \"FALSE\",\n \"lastLocationTime\": \"2023-09-07T10:40:52Z\"\n}"},{"id":"22426765-d164-41ad-973b-336b3564cc97","name":"Unknown","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"verificationResult\": \"UNKNOWN\"\n}"},{"id":"0bcf6e62-b475-410b-ae05-12443f1a19ee","name":"Partial match","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"verificationResult\": \"PARTIAL\",\n \"matchRate\": 74,\n \"lastLocationTime\": \"2023-09-07T10:40:52Z\"\n}"},{"id":"e11d682f-b540-49da-8bfb-3df09644414a","name":"Generic Invalid Argument","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"1523c60b-66be-4812-9f41-062f77c416dd","name":"Generic Out of Range","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"OUT_OF_RANGE\",\n \"message\": \"Client specified an invalid range.\"\n}"},{"id":"4156c29e-b46a-4343-a588-6851230654b8","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"2e1aba04-268f-4edc-9304-7a2249f452d7","name":"Generic Unauthenticated","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"ed75ceaf-640a-4456-8634-e2163dac5afa","name":"Generic Authentication Required","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"0da5dcb9-79f6-462a-a6e8-e0486730d73e","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"2cc8218a-adca-4968-8118-0f856960f066","name":"Generic Permission Denied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"9241f35d-74e4-4d58-9bca-796f704cef30","name":"Invalid access token context","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"9316e160-6d15-43fc-93e3-8bb56fb009f2","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"e4e020e1-a192-43dc-8b9b-0325816ed621","name":"Generic Not Found","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"{{resource}} is not found\"\n}"},{"id":"52b6d776-20a0-4223-ba9e-96d364ba0272","name":"Some identifier cannot be matched to a device","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"DEVICE_NOT_FOUND\",\n \"message\": \"No device found for a provided identifier\"\n}"},{"id":"00a6a973-396f-4607-aeb7-ceceb2d68088","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"{{resource}} is not found\"\n}"},{"id":"16efcb36-f87d-4f1b-9b5a-90d49218129d","name":"Unable to fulfill maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"LOCATION_VERIFICATION.UNABLE_TO_FULFILL_MAX_AGE\",\n \"message\": \"Unable to provide expected freshness for location\"\n}"},{"id":"09d881b1-edbc-4b07-a22b-bcb3bb0cfe5c","name":"Unprocessable entity","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNPROCESSABLE_ENTITY\",\n \"message\": \"Value not acceptable: ...\"\n}"},{"id":"73a13026-fcf5-491b-be2a-2c965434b18f","name":"Service not applicable to the device","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The device is not applicable for the requested operation\"\n}"},{"id":"96fea098-ced7-4047-ad7c-7acd800c73cd","name":"Device identifiers mismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"The provided device identifiers do not match the same device\"\n}"},{"id":"43c27e1f-1ff3-4eaf-96a7-7eb571bc1f37","name":"None of the provided device identifiers is supported by the implementation","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNSUPPORTED_DEVICE_IDENTIFIERS\",\n \"message\": \"Supported device supported are: ...\"\n}"},{"id":"6d120d4b-a08e-4df9-8d1e-ad66453ed3a2","name":"No identifier provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNIDENTIFIABLE_DEVICE\",\n \"message\": \"A device must be provided\"\n}"},{"id":"42151528-3fd3-4c58-a7dc-68528b3e1f93","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"a8d774aa-c1f9-4767-a832-41e45a5a71ef","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"319c97ca-ef17-453d-b7e6-54e45f1ef03b","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"9fc41df6-c48c-4688-9622-ccbddfdb7192","name":"Generic Internal","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"d5998744-4c64-4c53-a9ce-79283f31fe54","name":"IPv4 address, circle, without maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"a906edee-0dd2-45fe-9f30-b72a509b84cc","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Internal server error\"\n}"},{"id":"a118b730-49e0-45ce-adb6-221690fa775c","name":"Generic Unavailable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service unavailable\"\n}"},{"id":"b5128610-2c62-447a-ac38-ce36aa8a4a49","name":"IPv4 address, circle, without maxAge","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"ipv4Address\": {\n \"publicAddress\": \"123.234.1.2\",\n \"publicPort\": 1234\n }\n },\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service unavailable\"\n}"},{"id":"dbfbd265-c374-4cd0-b3b2-1043c66d3a7d","name":"Device not provided","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"area\": {\n \"areaType\": \"CIRCLE\",\n \"center\": {\n \"latitude\": 50.735851,\n \"longitude\": 7.10066\n },\n \"radius\": 50000\n },\n \"maxAge\": 120\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/verify"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service unavailable\"\n}"}],"_postman_id":"516fb192-1b15-473b-9505-5d61fbaec1b0"}],"id":"03ceca74-e871-4abe-b587-5acea12b78d8","description":"This API provides the consumer with the ability to verify the location of a device.
\nAPI consumers are able to verify whether the location of certain user device is within the area specified. Currently the only area supported as input is a circle determined by a set of coordinates (latitude and longitude) and some expected accuracy (radius).
\nThe verification result depends on the network's ability and accuracy to locate the device at the requested area.
\nIf the network's estimation of the device's location is fully contained within the requested area, the verification result is TRUE.
If the network's estimation of the device's location does not overlap with the requested area at all, the verification result is FALSE.
If the network's estimation of the device's location partially overlaps with the requested area, or it fully contains the requested area (because it is larger), the result is 'PARTIAL'. In this case, a match_rate is included in the response, indicating an estimation of the likelihood of the match in percent.
Lastly, the network may not be able to locate the device. In this case, the verification result is UNKNOWN.
The client may optionally include a maxAge indication. If the location information known to the server is older than the specified maxAge, an error 422 with code LOCATION_VERIFICATION.UNABLE_TO_FULFILL_MAX_AGE is sent back.
lastLocationTime will be always included in the success response unless there is no historical location information available for the device. In this case, UNKNOWN will be returned without lastLocationTime.
Location Verification could be useful in scenarios such as:
\nFraud protection, to ensure a given user is located in the location area claimed for financial transactions.
\nVerification of GPS coordinates reported by the app on a device, to ensure the GPS was not faked, e.g. for content delivery with regional restrictions.
\nContextual-based advertising, to trigger advertising after verifying the device is in the area of interest.
\nSmart mobility (vehicle / bikes renting), to confirm the location of the device and the location of the vehicle/bike to guarantee they are rented correctly.
\nDevice: A device refers to any physical entity that can connect to a network and participate in network communication.
\nArea: It specifies the geographical surface where a device may be physically located.
\nMax Age: Maximum age of the location information which is accepted for the location verification (in seconds).
\nAbsence of maxAge means \"any age\" is acceptable for the client. In other words, this is like maxAge=infinite. In this case the system will still return lastLocationTime, if available.
\nmaxAge=0 means a fresh calculation is requested by the client. If the system is not able to provide the fresh location, an error 422 with code LOCATION_VERIFICATION.UNABLE_TO_FULFILL_MAX_AGE is sent back.
\nVerification: Process triggered in the API server to confirm or contradict the expectation assumed by the API client about the device location.
\nThe API exposes a single endpoint/operation:
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.(FAQs will be added in a later version of the documentation)
\n","_postman_id":"03ceca74-e871-4abe-b587-5acea12b78d8"},{"name":"subscriptions/{subscription}","item":[{"name":"Operation to retrieve a subscription based on the provided ID","id":"8e699f02-34a1-49e4-8d8c-302689de4164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"retrieve Geofencing subscription information for a given subscription ID.
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"30c5fd8f-7d76-4888-9aae-d90c3ca53b22","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"qs15-h556-rt89-1298","key":"subscriptionId"}]}},"response":[{"id":"b00b81b0-ed89-46eb-8c82-9b15dffaed8c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 3462.6182063972365,\n \"privateAddress\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n },\n \"area\": {\n \"areaType\": \"CIRCLE\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"1119920371\",\n \"startsAt\": \"1964-10-02T13:00:47.161Z\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\"\n },\n \"expiresAt\": \"1955-10-30T02:47:20.350Z\",\n \"status\": \"ACTIVATION_REQUESTED\"\n}"},{"id":"34bf9eec-9ff2-4dde-b18c-a0fe021ce52d","name":"Schema validation failed","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"ff769280-33ca-429a-9572-9b68ac71c4c0","name":"subscription id is required","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"dc026598-3cbe-48f4-94da-561518817f04","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"5cbebd09-2723-4af5-8a49-8b4d979e3a85","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"6b4c8316-fe9a-401d-98f7-eba7ea4e496b","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"76ca041f-a2a4-4bfb-8fb6-cd208938e7ec","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"6589ca4d-dd6e-4c69-b29b-66e882f2112c","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"30f63720-6f32-4108-90b0-a15f0d997742","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"25f88f4d-4d7e-4835-90d1-85daa7ee145d","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"8e699f02-34a1-49e4-8d8c-302689de4164"},{"name":"Delete a Geofencing event subscription","id":"8de79cec-f95b-4a92-824f-30a6309db056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"delete a given Geofencing subscription.
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"a7375094-d5d7-4a0a-91f3-d5a4939f1d70","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"qs15-h556-rt89-1298","key":"subscriptionId"}]}},"response":[{"id":"bbf092cf-366e-4421-a618-6f83584ebce6","name":"Request accepted to be processed. It applies for async deletion process.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"qs15-h556-rt89-1298\"\n}"},{"id":"0c9c787c-41cd-4547-8609-437dbd934725","name":"Geofencing subscription deleted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":null},{"id":"f827347a-bfe8-4e9e-8330-703a4685043b","name":"Schema validation failed","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"38875716-6e3f-4eec-87d2-6525c3c4e90f","name":"subscription id is required","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"c5b61f38-fd0a-484e-8a5f-00b8ea2c8255","name":"Authentication problem with the client request","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"d5b8c418-d10c-478b-8b22-ceeaf34a9a4a","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"48800740-af7f-46fc-bd73-ce2d67cf0861","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"cc5ef9a1-d103-4dbf-87b7-b5852ba509e6","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"001cc4e2-f9d6-4e9d-9c63-0f314df228dc","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"X-Correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"f1c11f58-2582-444d-af97-2975e2d6dc45","name":"Server error","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"24f3da15-4941-4ac2-9b2a-817ac8cd87e2","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"qs15-h556-rt89-1298","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"8de79cec-f95b-4a92-824f-30a6309db056"}],"id":"ef1ef01a-2e4c-49da-bb29-e76e80e4cd9f","_postman_id":"ef1ef01a-2e4c-49da-bb29-e76e80e4cd9f","description":""}],"id":"fc4c7f1c-8d54-43ed-947e-a086a1542212","_postman_id":"fc4c7f1c-8d54-43ed-947e-a086a1542212","description":""},{"name":"Traffic Influence API","item":[{"name":"traffic-influences","item":[{"name":"Retries existing TrafficInfluence Resources","id":"6896bc74-6684-43d0-976f-bc06a7e2f5eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/traffic-influences?appId=6B29FC40-CA47-1067-B31D-00DD010662DA","description":"Reads all of the active TrafficInfluence resources owned by the same API Consumer
\n","urlObject":{"path":["traffic-influences"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Used to select traffic influence resources filtered by appId. For privacy reasons, if a resource is related to a user, the paramentr Device is not exchanged.
\n","type":"text/plain"},"key":"appId","value":"6B29FC40-CA47-1067-B31D-00DD010662DA"}],"variable":[]}},"response":[{"id":"ac4ea8f1-d62e-4cc5-b1f5-e9a3e1eabae0","name":"Returns the information about existing TrafficInfluence resources.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"f67733af-065a-b8c0-440d-703f7b89e526\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"b6eb34b3-c483-9a70-d00c-cdd7e43523cd\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 59915\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 56992,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influences","description":"Takes as input an object containing the intents from the API Consumer and creates a TrafficInfluence resourse accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.
\n","urlObject":{"path":["traffic-influences"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"90e443f9-c147-48ce-9a43-e7170a1db4fe","name":"TrafficInfluence resource created, the related object is returned with the resource ID (trafficInfluenceID) and status (state) valorised.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices","description":"Takes as input an object containing the intents from the API Consumer and creates a TrafficInfluence resourse accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response.
\n","urlObject":{"path":["traffic-influence-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"07bb3afe-dc3c-4c3d-974d-ebc3f2ee5cc7","name":"TrafficInfluence resource created, the related object is returned with the resource ID (trafficInfluenceID) and status (state) valorised.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""},{"disabled":false,"description":{"content":"Link to the created traffic influence resource","type":"text/plain"},"key":"Location","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"6e8bf15c-d575-1263-f7ab-96348836e40e\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"ce1573e4-a8ea-9b21-4c8b-21175a458bfc\",\n \"state\": \"error\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 3539\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 25917,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}"},{"id":"de8e4b68-f47c-4ea0-84ae-90bf13ef71f1","name":"Problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"da4e9485-7ccf-4f47-8d99-2ed04d318699","name":"Authentication problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials\"\n}"},{"id":"23f145a4-7110-4fcc-836f-538d8cbb2d5a","name":"PermissionDenied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"e673ba0f-3a09-4fbd-bb67-5688b479c1d9","name":"InvalidTokenContext","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"the phoneNumber parameter doesn't match the value from the access token context\"\n}"},{"id":"1eef4b6d-3f1f-463f-8842-6d2000347f13","name":"An unknow error has occurred","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"message\": \"Generic error\"\n}"},{"id":"70cb2f4e-e6a2-4256-9a35-5bacdb7d69b0","name":"Service unavailable. Typically the server is down","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service unavailable\"\n}"},{"id":"c8b505db-10e4-4b6e-8def-e21282e1bee9","name":"Connection timeout towards backend service has occurred","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"b027ada1-2d1f-e62c-17bc-6dcecd677e98\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"6545522b-7ca2-18a2-58da-4fa90e5954ab\",\n \"state\": \"ordered\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 30455\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 12035,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influence-devices"},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"message\": \"Backend connection timeout\"\n}"}],"_postman_id":"d3a2530d-46e2-4a5b-9ffa-18c33d2ae04b"}],"id":"93b0cca0-5137-44b9-a2e8-438fb3c536c7","_postman_id":"93b0cca0-5137-44b9-a2e8-438fb3c536c7","description":""},{"name":"traffic-influences/{trafficInfluenceID}","item":[{"name":"Reads a specific TrafficInfluence resource identified by the trafficInfluenceID value.","id":"e3203641-8abd-46ea-bc84-d21bba7d23f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/traffic-influences/:trafficInfluenceID","description":"Returns a specific TrafficInfluence resources owned by the same API Consumer. For privacy reasons, if a resource is related to a user, the parameter Device is not exchanged.
\n","urlObject":{"path":["traffic-influences",":trafficInfluenceID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"4d8dbf54-cc35-404e-afaa-514c9175da77","description":{"content":"Identifier of the specific TrafficInfluence resource to be retrieved, modified or deleted. It is the value used to fill trafficInfluenceID parameter.
\n","type":"text/plain"},"type":"any","value":"string","key":"trafficInfluenceID"}]}},"response":[{"id":"2e869438-081d-4972-8079-5eb2de0bbe72","name":"OK.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/traffic-influences/:trafficInfluenceID","description":"invoked by the API Consumer to stop influencing the traffic, deleting a TrafficInfluence resource previously created. The notification will be sent via Cloud Event with the information already available in the TrafficInfluence resource identified by \"trafficInfluenceID\".
\n","urlObject":{"path":["traffic-influences",":trafficInfluenceID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"94fe5407-a201-4aea-b6b0-d964ede44a6d","description":{"content":"Identifier of the specific TrafficInfluence resource to be retrieved, modified or deleted. It is the value used to fill trafficInfluenceID parameter.
\n","type":"text/plain"},"type":"any","value":"string","key":"trafficInfluenceID"}]}},"response":[{"id":"cf2ea68e-a4a2-4821-9be4-e0137ace4fef","name":"The resource delation request has been accepted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Correlation id for the different services.
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiConsumerId\": \"string\",\n \"appId\": \"6B29FC40-CA47-1067-B31D-00DD010662DA\",\n \"trafficInfluenceID\": \"string\",\n \"appInstanceId\": \"8d15d4d1-5dc1-6953-2b44-803c3c6616b5\",\n \"edgeCloudRegion\": \"string\",\n \"edgeCloudZoneId\": \"324d1311-a4e9-5452-f2bd-433a258ea9b3\",\n \"state\": \"deletion in progress\",\n \"sourceTrafficFilters\": {\n \"sourcePort\": 31431\n },\n \"destinationTrafficFilters\": {\n \"destinationPort\": 44817,\n \"destinationProtocol\": \"TCP\"\n },\n \"notificationUri\": \"string\",\n \"notificationAuthToken\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/traffic-influences/:trafficInfluenceID","description":"The resource identified by the trafficInfluenceID value can be modified. Before the PATCH can be invoked the status (state) of the resource must be \"active\". If not an errore code 409 (DENIED_WAIT) is returned.
\n","urlObject":{"path":["traffic-influences",":trafficInfluenceID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"330d91c6-d527-41ba-a51e-dc813e0ee3fc","description":{"content":"Identifier of the specific TrafficInfluence resource to be retrieved, modified or deleted. It is the value used to fill trafficInfluenceID parameter.
\n","type":"text/plain"},"type":"any","value":"string","key":"trafficInfluenceID"}]}},"response":[{"id":"e1093fee-0e09-44e3-8e39-eb61b98d9a64","name":"TrafficInfluence resource edited, the related object is returned, the status (state) is updated.","originalRequest":{"method":"PATCH","header":[{"description":"Correlation id for the different services.","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"The reference scenario foresees a Service, composed by one or more Service Producers deployed in different geographical locations in a distributed Telco Edge Cloud. The Service Producer, deployed at the Edge, is referred as Edge Application Server (EAS).
\nThe life cycle management of the EAS can be done with the CAMARA \"Edge Application Management API\" whose definition is in the CAMARA Edge Cloud repository (https://github.com/camaraproject/EdgeCloud). The Telco Edge Cloud is composed by Edge Cloud Regions that contain Edge Cloude Zones. For a more complete definition of such Telco Edge Cloud architecture, please refer to the \"Edge Application Management API\" documentation. A developer can deploy and run applications on an Edge Cloud Zone, meaning reduced latency to end users that are nearby, as the network path is shorter. A network operator's EdgeCloud may comprise multiple Edge Cloud Zones, each in a discrete location to bring latency benefits to end users across a country.
\nThe operator can help developers knowing which of the Edge Cloud Zones will bring the optimal performance for a given end user and application.
\nThe Traffic Influence API (TI API) provides the optimal routing from the user Device (e.g. a Smartphone) to the optimal EAS instance in a specific geographical location, installed in an Edge Cloud Zone.
\nIf a Service is offered by Cloud Instances and by Edge Instances, the TI API can be used get the optimal routing of the traffic to the Edge Instances, maybe for a set of users. Getting the optimal routing can be used to improve latency maybe in combination with other CAMARA APIs such as QoD (Quality On Demand). Providing the optimal routing is indeed an important step to get the optimal latency.
\nIf the TI API is used to get the best routing at the Edge for a Device in a geographical location and the Device moves to another geographical location, the TI API can be invoked to get the optimal routing in the new geographical location for that Device.
\nWhile the goal of the TI API is to optimise the traffic in the mobile network to reach the local instance of the EAS, it is a task of the Application to generate the flow toward the expected EAS Instance.
\nThe TI API provides the capability to establish the optimal routing, in terms of latency, in a specific geographical area, between the user Device, e.g. the user's smartphone, and the optimal EAS instance nearby. If the Device moves in a different geographical location where a more suitable EAS instance is available, the TI API can be invoked again to influence the Device connectivity to get the optimal routing also in the new location.
\nIt is important to notice that the service data flow is not automatically optimised when the user moves in a specific area, it is a task of the TI API Consumer to detect the changes in the Device location and to invoke the TI API consequently.
\nThe generic architecture for the Service can foresee some Cloud instances of the Application, one or more Edge Instances of the Application. The TI API Consumer invokes the TI API creating a \"TrafficInfluence\" resource specifying the desired intent.
\nThe TI API Producer implements the intent specified in the \"TrafficInfluence\" resource.
\nWhile the TI API can be invoked to activate the optimal routing for any user, it can also be used to request the optimal routing for a specific user also specifying, as an option, a source public port and a destination public port and protocol. Invoking the TI API for each user, many \"TrafficInfluence\" resources are created for each user to provide the requested routing for a set of users. If the TI API is invoked to provide the optimal routing for any user and later it is required to provide the optimal access only for selected users, the previous intent/resource must be deleted.
\nThe same approach is used for the geographical areas where the influence of the traffic must be applied. Invoking the TI API without specifying a geographical area, activates the optimal routing toward the closest EAS instance in any geographical location. This intent must be deleted if it is required to provide the optimal access only in selected areas. Invoking the TI API specifying a geographical area activates the optimal routing only if the user is in that geographical area. The flow is optimised to reach the EAS instance located closest to that geographical area. In a different geographical area the user will not have the traffic flow optimised.
\nTo activate the optimal routing in selected geographical areas, the TI API must be invoked for each geographical area. Anyway it is importat to understand that the traffic optimization strongly depends on the user's geographical location so it is important for the TI API Consumer to always verify the position of the user invoking the TI API for that user if it moves changing its location.
\nThe API API can also be used to optimise a specific traffic flow identified by a source port and a destination port and protocol. To optimise the flow from more source ports or destination ports or protocols, the TI API must be invoked many times.
\nIt is important to notice that it is a task of the Client Application to use the most adequate means to send the application flow to the right server (EAS), for example using Edge DNS or using the target EAS IP address. The TI API provides back the selected EAS instance identifier from which the Client Application can retrive the destination IP address of its backend server, to properly configure the service data flow.
\nThe TI API can be used to:
\nOptimise the routing when Devices need to consume the service provided by a local EAS Instances.
\nAffect an already established Device routing when the Device moves among different geographical locations. When the TI API consumer detects a Device has entered a geographical location where an EAS instance is available, it can invoke the TI API to get the optimal routing toward that EAS instance.
\nIf the Device moves to another geographical location, served by another EAS instance, the routing might not be optimal anymore. In the case the Application detects a location change, it can invoke the TI API again to request a new routing optimization toward the new EAS instance.
\nThe TI API is consumed by an Application Function (AF) requesting for the optimal routing, in term of latency, for the traffic flow from a Device toward EAS instances in Edge Cloud Zones.
\nWhen the Application (the EAS) is onboarded and deployed in the Edge Cloud Zones, the Application is identified with a unique identifier (\"appId\"). Using the application identifier (\"appId\") and specifying a Zone or a Region the Telco Operator Platform, autonomously identifies the best instance of the EAS toward which routing the traffic flow and configures the Mobile Network accordingly to get the fastest routing.
\nIf just the application identifier is used, the Telco Operator Platform identifies all the EAS Instances and activates the optimal routing on the Mobile Network.
\nIf the optimal routing in term of latency should be available just for a set of users, the TI API must be invoked for each user creating a new TrafficInfluce resource for each one.
\nIf the Application offers different services on different interfaces a traffic filter based on IP, Port and Protocol can be used. I this way it is also possible to redirect different users to different interfaces.
\nHere are some possible intents:
\nActivate the optimal routing for the closest EAS instance: the TI API must be invoked with the \"appId\". The Telco Operator Platform identifies all the EAS instances and activates the optimal routing on the Mobile Network so that the user is connect to the closest EAS insteance.
\nActivate the optimal routing in a specific Region or Zone: the TI API must be invoked with the \"appId\" and the Zones and Regions identifiers.
\nActivate the optimal routing for a user Device: the TI API can be invoked with a user Device identifier (\"Device\"). For each user Device, a TI API invocation is required. The optimal routing is provided only for the requested Devices.
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nNote that endpoints not exchanging sensitive data use OAuth2 with Client Credential while endpoint exchanging sensitive data use OpenId Connect.
\nIdentifying the phone number from the access token
\nThis specification defines the \"phoneNumber\" field as optional in API requests because using a 3-legged access token the phone number can be uniquely identified by the token.
\nOptional phone number object for 3-legged tokens:
When using a 3-legged access token, the phone number associated with the access token must be considered as the phone number for the API request. This means that the \"phoneNumber\" paramenter is not required in the request, and if it is included it must identify the same phone number.
Validation mechanism:
The server will extract the phone number identification from the access token, if available. If the API request additionally includes a \"phoneNumber\" parameter when using a 3-legged access token, the API will validate that the phone number identifier provided matches the one associated with the access token. If there is a mismatch, the API will respond with a 403 INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
Error handling for unidentifiable devices:
If the \"phoneNumber\" parameter is not included in the request and the phone number information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.
The usage of the TI API is based on the management of a \"TrafficInfluence\" resource, an object containing the intent requested invoking the TI API and that is implemented by the platform configuring the Mobile Network for the optimal routing toward the EAS instance.
\nThe \"TrafficInfluence\" resource can be created (providing the related parameters that specify the desired intent), queried, modified and deleted.
\nThe TI API is asynchronous, a notification is available providing information about the status of the requested resource.
\nFor an Application (identified by \"appId\") many \"TrafficInfluence\" resources can be created, e.g. to add multiple users, regions or zones.
\nWhen an intent is expressed and a resource have been created, if the intent must be modified, it is suggested to use the PATCH method (/traffic-influeces/{trafficInfluenceID}). Anyway, any other new intent (e.g. for the same device) will override the previous ones.
\nBase-Url:
The RESTful TI API endpoint, for example https://tim-api.developer.tim.it/trafficinfluence
TrafficInfluence:
This object represents the resource that carries the requirements from the user to be implemented. The TI API is invoked for the life cycle management of this resource (CRUD). The resource contains the intents from the TI API Consumer. Managing this resource, the developer can specify in which geographical location the routing must be applied, toward which application, maybe for a specific set of users or for a limited period of time.
trafficInfluenceID:
Identifier for the Traffic Influence resource. This parameter is returned by the TI API and must be used to update it (e.g., adding a Device or deleting it). A different Traffic Influence resource must be created for any Device or Zone or Region. All these resources are related to an Application identified by \"appId\".
apiConsumerId:
Unique identifier for the TI API Consumer.
edgeCloudRegion:
The Developer can specify in which geographical area he requires the optimal routing toward application instances running there. An Edge Cloud Region is equivalent to a Region on a Public Cloud. The higher construct in the hierarchy exposed to an Application Provider who wishes to deploy an Application on the Edge Cloud and broadly represents a geography. An Edge Cloud Region typically contains one or multiple Edge Cloud Zones. The Edge Cloud Region name is provided by the Telco Operator and can also be used or retrieved with other CAMARA APIs (e.g. \"Edge Application Management API\"). To add more regions the TI API must be invoked (POST) for each \"region\". If in a \"region\" there are many Application instances active in different \"zones\", the TI API can be invoked to configure the optimal routing for all the instances with just one API call specifying the \"region\". If just the Application instances in some Edge Cloud Zone must be affected, the TI API can be invoked for the zones of interest, without specifying the \"region\" in the API call. If just some specific Application instance must be affected, it is not required to specify any \"region\" or \"zone\", and the parameter \"appInstanceId\" can be used.
edgeCloudZoneId:
An Edge Cloud Zone is the lowest level of abstraction exposed to an Application Provider who wants to deploy an Application on Edge Cloud. Edge Cloud Zones exists within a Edge Cloud Region. To add more \"zones\" the TI API must be invoked (POST) for each \"zone\".
appId:
A globally unique identifier associated with the application. This identifier is provided during the application onboarding process. To influence the traffic toward a specific Application. It is the Operator Platform that detects the appropriate Application instance in the selected \"region\" or \"zone\".
appInstanceId:
A globally unique identifier generated by the Operator Platform to identify a specific instance of the Application in a specific zone. To influence a traffic toward a specific Application instance. If just some specific Application instance must be affected, it is not required to specify any \"region\" or \"zone\", the parameter \"appInstanceId\" can be used. The value for appInstanceId can be retrived using the CAMARA API: Edge Application Management (https://github.com/camaraproject/EdgeCloud/blob/main/code/API_definitions/Edge-Application-Management.yaml).
sourceTrafficFilters:
The traffic can be from a specific public port in the device. If this parameter is used, the influenced flow is from the public port defined in \"sourceTrafficFilters\" rathar than the public port specified in \"Device\"
destinationTrafficFilters:
The Application can expose different service on different interfaces, identified by port and protocol, with this parameter it is possible to route the traffic toward a specific port and protocol exposed by the Application.
Device:
An user Device can be provided as an input. The Device can be identified by the phone number (phoneNumber) or by its IP Address (Ipv4Address, Ipv6Address) also specifying a Port. For IP address both the private (as seen from inside the Device) and the public (as seen over Internet by a server connected to the Device) can be used. To add more users the TI API must be invoked (POST) of each user Device. New \"TrafficInfluence\" resources are created (with different \"trafficInfluenceID\"). The routing toward the selected Application instance is only applied for provided user Devices. \"publicPort\" can be used to identify the device. \"publicPort\" can be also used to identify the flow to be influenced. If the flow to be influenced is from a different public port, \"sourceTrafficFilters\" can be used. Note: if phone number is used, the value of this optional parameter must match the value of the phone number retrieved from the access token.
Notification:
Developers can specify a callback URL on which notifications regarding the requested intent can be received. The notification will be sent as a CloudEvent compliant message. For example to be notified when the requested optimal routing is active. It is also provided back the identificator for the selected EAS instace (\"selected_appInstanceId\") from which the Client Application can retrive the destination IP address of its backend server, to properly configure the service data flow. This information can be retrived using the CAMARA API: Edge Application Management (https://github.com/camaraproject/EdgeCloud/blob/main/code/API_definitions/Edge-Application-Management.yaml).
FAQ's
(FAQs will be added in a later version of the documentation)
Contact Support:
Email: project-email@sample.com
Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve","description":"Get the current roaming status and the country information
\n","urlObject":{"path":["retrieve"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b1d7f875-555a-40cb-aaa2-985f802afe9f","name":"No-Country-Name","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"roaming\": true,\n \"countryCode\": 901,\n \"countryName\": []\n}"},{"id":"f5697c16-d865-4142-bf77-10c25ef6c445","name":"Single-Country-Code","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"roaming\": true,\n \"countryCode\": 262,\n \"countryName\": [\n \"DE\"\n ]\n}"},{"id":"4746c0b4-c054-44a8-be77-f5536fb863ea","name":"Multiple-Country-Codes","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"roaming\": true,\n \"countryCode\": 340,\n \"countryName\": [\n \"BL\",\n \"GF\",\n \"GP\",\n \"MF\",\n \"MQ\"\n ]\n}"},{"id":"b410db8d-28cb-4ffa-bb4c-d7118e476f0b","name":"Problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"8d665185-3abf-4e6f-8940-f2e0e1959eae","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"d1a2f270-9dbf-442a-87d3-3df7684dc922","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"807c0225-4809-4c06-b4d4-da46af43bd50","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"f5614a5a-acba-405e-84a5-986bc6010b7d","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"55f86f27-d7e0-4d72-be69-2a35d68fcdab","name":"NOT_FOUND","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found\"\n}"},{"id":"4b330d4f-5617-44e5-bc66-5f52610b3a8d","name":"DEVICE_IDENTIFIER_NOT_FOUND","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"DEVICE_NOT_FOUND\",\n \"message\": \"Some identifier cannot be matched to a device\"\n}"},{"id":"694dc673-4260-4f2e-ae7e-9a58ab837a7f","name":"Not Acceptable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 406,\n \"code\": \"NOT_ACCEPTABLE\",\n \"message\": \"The server cannot produce a response matching the content requested by the client through `Accept-*` headers.\"\n}"},{"id":"6cd71d04-cca7-425f-8313-9ba6a3c08e4e","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 415,\n \"code\": \"UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"The server refuses to accept the request because the payload format is in an unsupported format.\"\n}"},{"id":"9040fc32-6625-4625-b1e0-84cebf9d5615","name":"GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"Provided device identifiers are not consistent.\"\n}"},{"id":"dac6d79c-01b9-4d63-b476-662dcbd581bd","name":"GENERIC_422_DEVICE_NOT_APPLICABLE","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The service is not available for the provided device.\"\n}"},{"id":"6e3fe856-7b19-4480-9510-7df391fe99cd","name":"GENERIC_422_UNABLE_TO_PROVIDE_ROAMING_STATUS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNABLE_TO_PROVIDE_ROAMING_STATUS\",\n \"message\": \"Network issue - Unable to provide roaming status\"\n}"},{"id":"bbc7c4fa-6f14-48e1-8366-f5e645eea385","name":"GENERIC_422_UNSUPPORTED_DEVICE_IDENTIFIERS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNSUPPORTED_DEVICE_IDENTIFIERS\",\n \"message\": \"None of the provided device identifiers is supported by the implementation\"\n}"},{"id":"d0d66536-6d4c-4529-932a-5ef4240d3265","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"1d5f7119-5c62-47b1-a7c5-7bc1859dd88d","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"36ba11b6-4418-48c8-8c64-0d4d13027e19","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Unknown server error. Typically a server bug.\"\n}"},{"id":"0b1042e9-9e22-4ac8-a013-92751531f3d6","name":"Not Implemented","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Implemented","code":501,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 501,\n \"code\": \"NOT_IMPLEMENTED\",\n \"message\": \"This functionality is not implemented yet.\"\n}"},{"id":"c5ba0d01-7dcf-4d35-afa7-3889dae75f11","name":"Bad Gateway","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 502,\n \"code\": \"BAD_GATEWAY\",\n \"message\": \"An upstream internal service cannot be reached.\"\n}"},{"id":"86d6cb28-4b0a-4d22-8640-09c21f8d3331","name":"Service Unavailable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"},{"id":"d4d71274-31fb-4dab-9998-2d371aed3497","name":"Gateway Timeout","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 767.867062817642,\n \"privateAddress\": true\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 504,\n \"code\": \"TIMEOUT\",\n \"message\": \"Request timeout exceeded.\"\n}"}],"_postman_id":"f9760622-1848-469e-9139-2167bbcbdb7b"}],"id":"2559647f-a862-4470-b0ab-b3d60783f7e8","description":"This API provides the API consumer with the ability to query device roaming Status
\nAPI consumer is able to verify whether a certain user device is in roaming situation (or not).
\nThe verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information could be returned in the response.
\nRoaming status verification could be useful in scenario such as (not exhaustive):
\nFor regulatory reasons, where a customer may need to be within a certain jurisdiction, or out with others, in order for transactions to be authorized
\nFor security / fraud reasons, to establish that a customer is located where they claim to be
\nFor service delivery reasons, to ensure that the customer has access to particular service, and will not incur roaming charges in accessing them
\nDevice: A device refers to any physical entity that can connect to a network and participate in network communication.
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
Roaming : Roaming status - true, if device is in roaming situation - false else.
Country : Country code and name - visited country information, provided if the device is in roaming situation.
\nLastStatusTime : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain.
\nThe API exposes following capabilities:
\nThe endpoint POST /retrieve allows to get roaming status and country information (if device in roaming situation) synchronously.
The \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.(FAQs will be added in a later version of the documentation)
\n","_postman_id":"2559647f-a862-4470-b0ab-b3d60783f7e8"},{"name":"device-roaming-status/subscription","item":[{"name":"Create a roaming status event subscription for a device","id":"64dd9bca-6fda-4838-a351-2b88dbfbb91a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions","description":"Create a roaming status event subscription for a device
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7a0f33e4-4bf0-42b5-85a6-22c10ca2858e","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": 9186.749322908934,\n \"privateAddress\": 6923\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"1953-05-30T02:24:49.429Z\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n },\n \"expiresAt\": \"1975-02-07T11:57:20.990Z\",\n \"status\": \"DELETED\"\n}"},{"id":"ffff6351-bea0-4f47-b261-5b408f1f4620","name":"Request accepted to be processed. It applies for async creation process.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"},{"id":"ca358ff6-2cb2-4dee-9e72-90d2f7cbc2b8","name":"InvalidArgument","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"eddda5d0-7186-4623-8b3d-347a80302d6c","name":"InvalidProtocol","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_PROTOCOL\",\n \"message\": \"Only HTTP is supported\"\n}"},{"id":"c44f3525-23c9-4526-8cf6-6509d4e0b80a","name":"InvalidCredential","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_CREDENTIAL\",\n \"message\": \"Only Access token is supported\"\n}"},{"id":"f277afc3-df2b-4477-a854-c5b8bd5237c7","name":"InvalidToken","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_TOKEN\",\n \"message\": \"Only bearer token is supported\"\n}"},{"id":"dcdf495f-f229-4fa5-aa91-ebcd2ec899b6","name":"Authentication problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"c099e133-dae9-457f-9e91-ff747fd071c2","name":"PermissionDenied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"4e18c4f6-9e3f-4a61-99c2-3bda74ce3704","name":"TokenMismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"SUBSCRIPTION_MISMATCH\",\n \"message\": \"Inconsistent access token for requested events subscription\"\n}"},{"id":"0d2c6635-dc72-4738-aaf3-15397c3c2734","name":"Conflict","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 409,\n \"code\": \"CONFLICT\",\n \"message\": \"The specified resource is in a conflict\"\n}"},{"id":"df6efaa9-42ff-4a91-9e54-bdde4a4d254e","name":"MultieventSubscriptionNotSupported","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED\",\n \"message\": \"Multi event types subscription not managed\"\n}"},{"id":"de9fe441-9b22-4f0d-a1f8-c715b2094cbd","name":"DeviceIdentifierMismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"Provided device identifiers are not consistent.\"\n}"},{"id":"faad2f00-7098-4ac4-903e-43bb8ac7e82a","name":"DeviceNotApplicable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The service is not available for the provided device.\"\n}"},{"id":"8e72f29b-9401-4eb9-bc43-8f01676144e9","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"cb7af7e3-05a6-473b-b4da-91042219d57a","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"db0b7b9d-4575-4a51-8bff-dc146a315154","name":"Server error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"03967a11-b4a1-45fd-a69c-b31e5c4f4cdf","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"publicPort\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-status\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"64dd9bca-6fda-4838-a351-2b88dbfbb91a"},{"name":"Retrieve a list of device roaming status event subscription","id":"163e1718-5ab8-4ec4-8832-087dc49cce92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions","description":"Retrieve a list of device roaming status event subscription(s)
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5733d779-41bd-421f-8b44-9381645ed84e","name":"List of event subscription details","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": true,\n \"privateAddress\": 2028.1013028630057\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"2007-11-07T06:42:39.933Z\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n },\n \"expiresAt\": \"2011-04-03T21:35:14.604Z\",\n \"status\": \"DELETED\"\n },\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": 5989\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"1988-01-23T06:48:16.465Z\",\n \"sinkCredential\": {\n \"credentialType\": \"ACCESSTOKEN\"\n },\n \"expiresAt\": \"1969-07-17T09:08:03.740Z\",\n \"status\": \"ACTIVE\"\n }\n]"},{"id":"19ff8d4d-0170-4a03-9bef-cfd6b7693040","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"83561567-df8e-4a72-905b-fe29ec172dee","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"72037aa1-4ac1-4a66-ad96-76d829da1946","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"96e2f6f0-8bc1-47a1-b861-9d1a659f030c","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"dd363cf8-f235-46fd-a397-7a7f333275fc","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"163e1718-5ab8-4ec4-8832-087dc49cce92"}],"id":"9ae8a59e-8b83-4bbc-883b-c9f2553a224a","description":"This API provides the API consumer with the ability to subscribe to Roaming status events.
\nAPI consumer is able to be notified whether the roaming status of a certain user device has changed.
This capability is provided via a subscription request - in this case the roaming situation is not in the response but event notification is sent back to the event subscriber when roaming situation has changed.
The API exposes following capability:
\nThese endpoints allow to manage event subscription on roaming device status event.
The CAMARA subscription model is detailed in the CAMARA API design guideline document and follows CloudEvents specification.
When subscribing, it is mandatory to provide the event type you are subscribing to, as multiple subscription-types are managed by this API.
Following event type are managed for this API:
org.camaraproject.roaming-status-subscriptions.v0.roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely
org.camaraproject.roaming-status-subscriptions.v0.roaming-on - Event triggered when the device switch from roaming OFF to roaming ON
org.camaraproject.roaming-status-subscriptions.v0.roaming-off: Event triggered when the device switch from roaming ON to roaming OFF
org.camaraproject.roaming-status-subscriptions.v0.roaming-change-country: Event triggered when the device in roaming change country code
Note: Additionally to these list, org.camaraproject.roaming-status-subscriptions.v0.subscription-ends notification type is sent when the subscription ends.
This notification does not require dedicated subscription.
It is used in following cases:
\nthe subscription expire time (optionally set by the requester) has been reached
\nthe maximum number of subscription events (optionally set by the requester) has been reached
\nthe subscription was deleted by the requester
\nthe Access Token sinkCredential (optionally set by the requester) expiration time has been reached
the API server has to stop sending notification prematurely
\nThis endpoint describes the event notification received on subscription listener side when the event occurred.
As for subscription, detailed description of the event notification is provided in the CAMARA API design guideline document.
WARNING****__: This callback endpoint must be exposed on the consumer side as _POST /{$request.body#/sink}_.__Developers may provide a callback URL on which notifications regarding reachability-status can be received from the service provider._If an event occurs the application will send events to the provided webhook - _sink__.
(FAQs will be added in a later version of the documentation)
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\n","_postman_id":"9ae8a59e-8b83-4bbc-883b-c9f2553a224a"},{"name":"device-roaming-status/subscription/{subscriptionId}","item":[{"name":"Retrieve a roaming status event subscription for a device","id":"ce1387df-a300-4fba-a939-c6dd400d8829","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"Retrieve a given subscription by ID
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"6ea1324a-79d5-4a4c-a0f1-f8d5a0f7ef63","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"subscriptionId"}]}},"response":[{"id":"d244e19b-efa2-490d-8cb1-a63c4d42ca5b","name":"subscription-active","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-on\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"ACTIVE\"\n}"},{"id":"f3bab883-794c-4568-88b4-23e30dd2c4f5","name":"subscription-activation-requested","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-on\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"ACTIVATION_REQUESTED\"\n}"},{"id":"6cc47891-5971-4b04-8c9d-81c1f9c2373b","name":"subscription-deleted","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.roaming-status-subscriptions.v0.roaming-on\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"DELETED\"\n}"},{"id":"47e2b1c5-17f9-4348-8ebf-3da092431d42","name":"Schema validation failed","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"d49cd332-0683-4f4a-90ba-5495dd7a3696","name":"subscription id is required","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"a9c20484-1a2d-446e-b5f8-e9520a68b7e2","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"628d294c-2488-4cac-82a2-5191fa0d0c55","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"9c740b13-56a4-4997-9544-5656d07ba4ce","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"fe88ef42-d7ec-4467-9107-944649c1c71d","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"effb2f8a-dee6-4c51-9f0d-36417c4b7048","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"a87a41ea-b010-42de-a9f6-074d64bec06f","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"c1ff51fd-1715-4c06-9438-fbcd69c96ec7","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"ce1387df-a300-4fba-a939-c6dd400d8829"},{"name":"Delete a roaming status event subscription for a device","id":"c57a3614-ca9c-4793-95f2-4fec7db181a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"Delete a given subscription by ID
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e973ed10-8971-4f03-ade8-902a7c445410","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"subscriptionId"}]}},"response":[{"id":"787b97a2-9aca-4dfd-9582-39b0dcd42e5e","name":"Request accepted to be processed. It applies for async deletion process.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"},{"id":"be5845e8-8c9a-4f2c-85f1-62954843b2e7","name":"event subscription deleted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":null},{"id":"3c11f033-da77-4001-b967-a325beac5525","name":"Schema validation failed","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"fbf6a51c-eb68-4e48-8d08-16440b86d6c8","name":"subscription id is required","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"3c5d6587-a4cf-4796-be3d-14de1d622740","name":"Authentication problem with the client request","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"2ba760d3-0ea8-4e80-97d7-cfa54c05363d","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"6de41e00-6cb1-452f-8782-1f22fdc06081","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"3a925a35-e888-4a82-a9a2-76e3d323d79c","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"17d65225-1cea-48ad-999b-3a023cae6295","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"c5ef7f89-17ba-4806-bd8a-d7e1c29174e7","name":"Server error","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"b5611f97-45e1-4446-84f9-d2fe81f3178b","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"c57a3614-ca9c-4793-95f2-4fec7db181a2"}],"id":"9b2758cf-a082-43d6-81cd-c556260ef0af","_postman_id":"9b2758cf-a082-43d6-81cd-c556260ef0af","description":""},{"name":"device-reachability-status/subscriptions","item":[{"name":"Create a device reachability status event subscription for a device","id":"738a9645-2d61-4217-9084-532ddfe3c745","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions","description":"Create a device reachability status event subscription for a device
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"910d1a6f-12a7-438a-979b-d376a0410ba8","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": false\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"2013-08-17T15:47:23.709Z\",\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n },\n \"expiresAt\": \"2023-03-27T15:39:21.194Z\",\n \"status\": \"EXPIRED\"\n}"},{"id":"1837e949-17cc-46fc-a8b7-65f68c81f124","name":"Request accepted to be processed. It applies for async creation process.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"},{"id":"6ca6c82c-d4c1-4a94-8c98-742cd6155a8b","name":"InvalidArgument","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"d4d50f45-1961-4e99-a182-9b22f08b5fa6","name":"InvalidProtocol","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_PROTOCOL\",\n \"message\": \"Only HTTP is supported\"\n}"},{"id":"defdc796-d797-46a8-90b5-bdfbeb09bf0e","name":"InvalidCredential","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_CREDENTIAL\",\n \"message\": \"Only Access token is supported\"\n}"},{"id":"3892b7d5-fc4d-4e40-b011-0628a915b803","name":"InvalidToken","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_TOKEN\",\n \"message\": \"Only bearer token is supported\"\n}"},{"id":"c7d47853-63e0-486b-af3e-32391ace4b4d","name":"Authentication problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"be5dfd0b-9496-4b06-87ba-030c778995e0","name":"PermissionDenied","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"86af8bfe-e5d3-45cb-8414-642ea5b36170","name":"TokenMismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"SUBSCRIPTION_MISMATCH\",\n \"message\": \"Inconsistent access token for requested events subscription\"\n}"},{"id":"b58c0bbb-3f51-4398-b0f6-518a6d2588df","name":"Conflict","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 409,\n \"code\": \"CONFLICT\",\n \"message\": \"The specified resource is in a conflict\"\n}"},{"id":"aa3a179f-eff1-4a0b-a75c-0a95dce7c0d4","name":"MultieventSubscriptionNotSupported","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED\",\n \"message\": \"Multi event types subscription not managed\"\n}"},{"id":"02662a54-e2ea-4e0c-85b0-c84a206725dd","name":"DeviceIdentifierMismatch","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"Provided device identifiers are not consistent.\"\n}"},{"id":"d8f3610f-fffd-460f-9a0b-6f605b556424","name":"DeviceNotApplicable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The service is not available for the provided device.\"\n}"},{"id":"567ec6d6-8c5a-446f-8a5d-8a73672ab898","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"1dbed769-82c1-4c1f-b21d-9583e377bfd9","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"6363ea80-9430-4d25-b8a7-e4aab3900c7a","name":"Server error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"9c53ae92-a632-4d41-9736-046e436c7c64","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"publicPort\": false\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms\"\n ],\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"738a9645-2d61-4217-9084-532ddfe3c745"},{"name":"Retrieve a list of device reachability status event subscription","id":"e4de8c17-194e-4f9c-8e21-95da91bba701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions","description":"Retrieve a list of device reachability status event subscription(s)
\n","urlObject":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b9858d58-3483-472f-a41a-50092e7124b2","name":"List of event subscription details","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": false,\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": false\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"1986-07-24T05:36:07.786Z\",\n \"sinkCredential\": {\n \"credentialType\": \"REFRESHTOKEN\"\n },\n \"expiresAt\": \"2020-11-12T11:37:40.427Z\",\n \"status\": \"ACTIVE\"\n },\n {\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": 4705.906972754721\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n },\n \"subscriptionExpireTime\": \"2023-01-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"types\": [\n \"string\",\n \"string\"\n ],\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"startsAt\": \"1996-10-31T02:20:59.381Z\",\n \"sinkCredential\": {\n \"credentialType\": \"PLAIN\"\n },\n \"expiresAt\": \"1994-03-11T20:47:23.635Z\",\n \"status\": \"EXPIRED\"\n }\n]"},{"id":"6f2dce0d-7e9d-4349-976d-be6b938f8099","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"0247909f-9263-466a-aa8e-771335af767f","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"db7c63d0-8174-4e83-a56e-d0ea105ef00b","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"c17672c6-6a8e-4817-a7f2-c1c042b2b586","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"0e2130dc-05c0-4524-9ef8-44f98c8d7d88","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"99e62d8f-9ff6-498f-81c2-908d63fcb123","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"23fc6e6c-5dbb-408a-ad88-4584d7975161","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"e4de8c17-194e-4f9c-8e21-95da91bba701"}],"id":"1d173a55-a79d-4f2c-b032-0393b3ba2af1","description":"This API provides the API consumer with the ability to subscribe to Reachability status events.
\nAPI consumer is able to be notified whether the reachability status of a certain user device has changed to either data- or sms-usage.
This capability is provided via a subscription request - in this case the reachability situation is part of the event notification, which is sent back to the event subscriber when reachability situation has changed.
The API exposes following capability:
\nThese endpoints allow to manage event subscription on reachability device status event.
The CAMARA subscription model is detailed in the CAMARA API design guideline document and follows CloudEvents specification.
When subscribing, it is mandatory to provide the event types you are subscribing to, as multiple subscription-types are managed by this API.
Following event types are managed for this API:
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data: Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms: Event triggered when the device is connected to the network only for SMS usage
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected: Event triggered when the device is not connected.
Note: Additionally to these list, org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends notification type is sent when the subscription ends.
This notification does not require dedicated subscription.
It is used in following cases:
\nthe subscription expire time (optionally set by the requester) has been reached
\nthe maximum number of subscription events (optionally set by the requester) has been reached
\nthe subscription was deleted by the requester
\nthe Access Token sinkCredential (optionally set by the requester) expiration time has been reached
the API server has to stop sending notification prematurely
\nThis endpoint describes the event notification received on subscription listener side when the event occurred.
As for subscription, detailed description of the event notification is provided in the CAMARA API design guideline document.
WARNING_: This callback endpoint must be exposed on the consumer side as _POST /{$request.body#/sink}__.
Developers may provide a callback URL on which notifications regarding reachability-status can be received from the service provider.
If an event occurs the application will send events to the provided webhook - _sink_.
(FAQs will be added in a later version of the documentation)
\nThe \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\n","_postman_id":"1d173a55-a79d-4f2c-b032-0393b3ba2af1"},{"name":"device-reachability-status/retrieve","item":[{"name":"Get the current reachability status information","id":"c954d3f7-cdbc-4a02-b2e9-125f5af06124","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve","description":"Get the current reachability status information
\n","urlObject":{"path":["retrieve"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3bc9806e-2893-4167-8024-bf74a983f688","name":"Connected-With-SMS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"reachabilityStatus\": \"CONNECTED_SMS\"\n}"},{"id":"11171e91-3933-400c-81ff-31090600085c","name":"Connected-With-DATA","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"reachabilityStatus\": \"CONNECTED_DATA\"\n}"},{"id":"2aad413e-5e8c-4b63-8f89-1e3a5eeef1ea","name":"Not-Connected","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"lastStatusTime\": \"2024-02-20T10:41:38.657Z\",\n \"reachabilityStatus\": \"NOT_CONNECTED\"\n}"},{"id":"df91b87b-ef4f-4f91-a24a-cb5686c418c9","name":"Problem with the client request","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param.\"\n}"},{"id":"09b3a36e-3b18-4668-9cd0-20c49a01518b","name":"GENERIC_401_UNAUTHENTICATED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"c6a0f456-38a4-43e4-8731-1e1b9c645a3e","name":"GENERIC_401_AUTHENTICATION_REQUIRED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"AUTHENTICATION_REQUIRED\",\n \"message\": \"New authentication is required.\"\n}"},{"id":"40c47db7-d9da-4797-8485-059bd2b70d7e","name":"GENERIC_403_PERMISSION_DENIED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action.\"\n}"},{"id":"05808f25-8623-4538-8fcd-95ee5b121518","name":"GENERIC_403_INVALID_TOKEN_CONTEXT","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"INVALID_TOKEN_CONTEXT\",\n \"message\": \"{{field}} is not consistent with access token.\"\n}"},{"id":"fdbeafad-a2b6-4863-8338-f2c3b8e230d3","name":"NOT_FOUND","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found\"\n}"},{"id":"a9c343ea-b61e-4f57-9e0b-003f4eb6b2bd","name":"DEVICE_IDENTIFIER_NOT_FOUND","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"DEVICE_NOT_FOUND\",\n \"message\": \"Some identifier cannot be matched to a device\"\n}"},{"id":"0aa9cf11-71de-4587-b4da-cd9d1cbd737b","name":"Not Acceptable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 406,\n \"code\": \"NOT_ACCEPTABLE\",\n \"message\": \"The server cannot produce a response matching the content requested by the client through `Accept-*` headers.\"\n}"},{"id":"fe88cab5-a133-4358-82d2-b406d6fca00b","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 415,\n \"code\": \"UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"The server refuses to accept the request because the payload format is in an unsupported format.\"\n}"},{"id":"95a70511-cfb1-4761-acab-60e05fb41191","name":"GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_IDENTIFIERS_MISMATCH\",\n \"message\": \"Provided device identifiers are not consistent.\"\n}"},{"id":"96e76ee9-1db7-4f57-824e-b22d6f5e0be9","name":"GENERIC_422_DEVICE_NOT_APPLICABLE","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"DEVICE_NOT_APPLICABLE\",\n \"message\": \"The service is not available for the provided device.\"\n}"},{"id":"78241eab-5f07-4056-9f92-866b8b0dcd35","name":"GENERIC_422_UNABLE_TO_PROVIDE_REACHABILITY_STATUS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNABLE_TO_PROVIDE_REACHABILITY_STATUS\",\n \"message\": \"Network issue - Unable to provide reachability status\"\n}"},{"id":"1a1fd920-8d82-48da-8c10-bf606acf8daa","name":"GENERIC_422_UNSUPPORTED_DEVICE_IDENTIFIERS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"code\": \"UNSUPPORTED_DEVICE_IDENTIFIERS\",\n \"message\": \"None of the provided device identifiers is supported by the implementation\"\n}"},{"id":"f4af2937-edcd-49ec-b337-fe98f289592f","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"bc1d8810-59ca-4cda-9480-3e57e762ee6c","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"87b50412-3554-4000-9740-e393eb1a98d8","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Unknown server error. Typically a server bug.\"\n}"},{"id":"e1b836ed-2b22-433e-8b79-ef5a997d017b","name":"Not Implemented","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Not Implemented","code":501,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 501,\n \"code\": \"NOT_IMPLEMENTED\",\n \"message\": \"This functionality is not implemented yet.\"\n}"},{"id":"8258c5d3-66c4-4c34-9444-6168a24702d5","name":"Bad Gateway","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 502,\n \"code\": \"BAD_GATEWAY\",\n \"message\": \"An upstream internal service cannot be reached.\"\n}"},{"id":"429c0c49-b8e4-4700-991a-6eb33492e722","name":"Service Unavailable","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"},{"id":"ebc07492-925f-48a6-8f12-b09bdccf29bb","name":"Gateway Timeout","originalRequest":{"method":"POST","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device\": {\n \"phoneNumber\": \"+123456789\",\n \"networkAccessIdentifier\": \"123456789@domain.com\",\n \"ipv4Address\": {\n \"publicAddress\": \"string\",\n \"privateAddress\": \"string\"\n },\n \"ipv6Address\": \"2001:db8:85a3:8d3:1319:8a2e:370:7344\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/retrieve"},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 504,\n \"code\": \"TIMEOUT\",\n \"message\": \"Request timeout exceeded.\"\n}"}],"_postman_id":"c954d3f7-cdbc-4a02-b2e9-125f5af06124"}],"id":"b7177dfc-a867-451c-afda-80e85a4541e0","description":"This API provides the API consumer with the ability to query device roaming Status
\nAPI consumer is able to verify whether a certain user device is in roaming situation (or not).
\nThe verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information could be returned in the response.
\nRoaming status verification could be useful in scenario such as (not exhaustive):
\nFor regulatory reasons, where a customer may need to be within a certain jurisdiction, or out with others, in order for transactions to be authorized
\nFor security / fraud reasons, to establish that a customer is located where they claim to be
\nFor service delivery reasons, to ensure that the customer has access to particular service, and will not incur roaming charges in accessing them
\nDevice: A device refers to any physical entity that can connect to a network and participate in network communication.
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
Roaming : Roaming status - true, if device is in roaming situation - false else.
Country : Country code and name - visited country information, provided if the device is in roaming situation.
\nLastStatusTime : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain.
\nThe API exposes following capabilities:
\nThe endpoint POST /retrieve allows to get roaming status and country information (if device in roaming situation) synchronously.
The \"Camara Security and Interoperability Profile\" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
\nWhich specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
\nIt is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
\nThis specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.
The server will extract the device identification from the access token, if available.
\nIf the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.
\ndevice object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.(FAQs will be added in a later version of the documentation)
\n","_postman_id":"b7177dfc-a867-451c-afda-80e85a4541e0"},{"name":"device-reachability-status/subscriptions/{subscriptionId}","item":[{"name":"Retrieve a device reachability status event subscription for a device","id":"26f08e3d-cc01-4faf-b5c4-81b2bf60e30a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"Retrieve a given subscription by ID
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"8cf1b80e-0266-4c7e-a049-6d43b2e442f4","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"subscriptionId"}]}},"response":[{"id":"589d68f8-7d2a-43f8-9811-31e1b9b07338","name":"subscription-active","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"ACTIVE\"\n}"},{"id":"71dbdc1e-8336-4f76-96ec-f40ca8512f92","name":"subscription-activation-requested","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"ACTIVATION_REQUESTED\"\n}"},{"id":"e4f4a311-c1a3-4a74-a808-1cf32a4cefb5","name":"subscription-deleted","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"sink\": \"https://endpoint.example.com/sink\",\n \"protocol\": \"HTTP\",\n \"types\": [\n \"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data\"\n ],\n \"config\": {\n \"subscriptionDetail\": {\n \"device\": {\n \"phoneNumber\": \"+123456789\"\n }\n },\n \"subscriptionExpireTime\": \"2024-07-17T13:18:23.682Z\",\n \"subscriptionMaxEvents\": 5,\n \"initialEvent\": true\n },\n \"startsAt\": \"2024-07-03T21:12:02.871Z\",\n \"expiresAt\": \"2024-07-03T21:12:02.871Z\",\n \"status\": \"DELETED\"\n}"},{"id":"92208324-822b-421e-b481-216404a24b38","name":"Schema validation failed","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"586c2b04-ef9a-4f27-8aae-53ce253b5baf","name":"subscription id is required","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"a982f470-64bf-466a-bebf-9626618ab2a9","name":"Authentication problem with the client request","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"ef77864f-6d08-4a52-b3c6-95ef181c8513","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"643e830a-e2f1-406e-9600-ccc7b74526d1","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"208f2e57-3555-4575-9093-8e403d47db62","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"fe1e1b2f-8452-4925-95f8-a684d5a3c88c","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"ce2849f0-9e0c-4d1a-9c2c-ed71d6c4eec7","name":"Server error","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"296fbfd7-abd2-4839-b6c8-50053415d9a2","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"GET","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"26f08e3d-cc01-4faf-b5c4-81b2bf60e30a"},{"name":"Delete a device reachability status event subscription for a device","id":"255d5d1f-fd94-4047-933a-4460935612dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Correlation id for the different services
\n","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/subscriptions/:subscriptionId","description":"Delete a given subscription by ID
\n","urlObject":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"b3732b9d-1146-4b2f-8838-c75c0668e376","description":{"content":"Subscription identifier that was obtained from the create event subscription operation
\n","type":"text/plain"},"type":"any","value":"550e8400-e29b-41d4-a716-446655440000","key":"subscriptionId"}]}},"response":[{"id":"1422be0e-6eb2-42bc-933f-b4ec23b939d2","name":"Request accepted to be processed. It applies for async deletion process.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"subscriptionId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"},{"id":"83781a55-f4a2-4cd5-b689-0fc29a2bb360","name":"event subscription deleted","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":null},{"id":"cd356039-8600-4aa5-a6ba-d52ebf8c1844","name":"Schema validation failed","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Client specified an invalid argument, request body or query param\"\n}"},{"id":"8c86199f-8c1b-46f9-b9c1-93dd5b769cd7","name":"subscription id is required","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"code\": \"INVALID_ARGUMENT\",\n \"message\": \"Expected property is missing: subscriptionId\"\n}"},{"id":"aaaa6612-2c28-4db5-98b6-13ba7fb1bd30","name":"Authentication problem with the client request","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 401,\n \"code\": \"UNAUTHENTICATED\",\n \"message\": \"Request not authenticated due to missing, invalid, or expired credentials.\"\n}"},{"id":"5866bf1f-2bc7-49ce-8479-b70d6673e903","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"PERMISSION_DENIED\",\n \"message\": \"Client does not have sufficient permissions to perform this action\"\n}"},{"id":"9e7f3775-7b68-4b6d-a395-0b86fec8faf8","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"NOT_FOUND\",\n \"message\": \"The specified resource is not found.\"\n}"},{"id":"5a8e6a4e-36f7-4676-a3ef-4d0df8b56d6a","name":"GENERIC_429_QUOTA_EXCEEDED","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"QUOTA_EXCEEDED\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"3f9511ce-ad73-4ff1-9fbc-675f49af3994","name":"GENERIC_429_TOO_MANY_REQUESTS","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 429,\n \"code\": \"TOO_MANY_REQUESTS\",\n \"message\": \"Either out of resource quota or reaching rate limiting.\"\n}"},{"id":"a541643a-9ec9-4471-956c-1fb4f1915623","name":"Server error","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"code\": \"INTERNAL\",\n \"message\": \"Server error\"\n}"},{"id":"58adb1fc-66c4-4569-98a8-f803d8baf3e5","name":"Service unavailable. Typically the server is down.","originalRequest":{"method":"DELETE","header":[{"description":"Correlation id for the different services","key":"x-correlator","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subscriptions/:subscriptionId","host":["{{baseUrl}}"],"path":["subscriptions",":subscriptionId"],"variable":[{"key":"subscriptionId","value":"550e8400-e29b-41d4-a716-446655440000","description":"Subscription identifier that was obtained from the create event subscription operation"}]}},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-correlator","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 503,\n \"code\": \"UNAVAILABLE\",\n \"message\": \"Service Unavailable.\"\n}"}],"_postman_id":"255d5d1f-fd94-4047-933a-4460935612dd"}],"id":"75944fea-a653-4b72-8c4f-3e046493658a","_postman_id":"75944fea-a653-4b72-8c4f-3e046493658a","description":""}],"id":"26801fd5-219e-4e5e-b002-bed7214a09af","_postman_id":"26801fd5-219e-4e5e-b002-bed7214a09af","description":""}]}