| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET usage_authorisations/show
This method returns information related with a usage authorisation request. A single Usage Authorisation is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Usage Authorisation Identifier
The identifier of the usage authorisation. The allowed alert Identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"authorisation_date": "2017-03-30T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000008125",
"name": "ACR0000008125",
"id": "A99AC83A26B9488089DFD9EFAB40BED8",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_1",
"id": "932C4BC5D2374AA5AEA2DB3EDC4426D2",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "79890340CF9B4896A366C95B6042C970",
"life_cycle_state": "BLOCKED",
"expiration_date": "2017-04-30T20:12:54"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"authorisation_date": "2017-03-30T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "D5FD16BDA3AA4F79B9304F58646D4F2F",
"life_cycle_state": "BLOCKED",
"subscription": {
"number": "S0000008518",
"first_activated_date": "2017-03-30T20:02:28",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE"
},
"id": "5094D412B5A6495E8BAF6DD4A9E45FD9",
"life_cycle_state": "EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
},
"expiration_date": "2017-04-30T20:13:10",
"completed_by_action": {
"business_classification_code": "ADD_SERVICE_USAGE",
"number": "21882",
"submitted_on": "2017-03-30T21:01:04",
"action_type": null,
"executed_on": "2017-03-30T21:01:09",
"id": "B04DCEAE62534B3CA0C5F63D2F0B370F",
"life_cycle_state": "EXECUTED",
"performed_on": null,
"sub_action_type": null,
"behavior_code": "ADD_SERVICE_USAGE"
},
"completed_date": "2017-03-30T21:01:09"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST usage_authorisations/list
This method returns information related with usage authorisation requests that were submitted against a specific account receivable. Multiple usage authorisations are returned by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
The identifier of the accounts receivable related with the usage authorisations that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000011921"}
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"authorisation_date": "2017-03-30T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "D5FD16BDA3AA4F79B9304F58646D4F2F",
"life_cycle_state": "COMPLETED",
"subscription": {
"number": "S0000008518",
"first_activated_date": "2017-03-30T20:02:28",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE"
},
"id": "5094D412B5A6495E8BAF6DD4A9E45FD9",
"life_cycle_state": "EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
},
"expiration_date": "2017-04-30T20:13:10",
"completed_by_action": {
"business_classification_code": "ADD_SERVICE_USAGE",
"number": "21882",
"submitted_on": "2017-03-30T21:01:04",
"action_type": null,
"executed_on": "2017-03-30T21:01:09",
"id": "B04DCEAE62534B3CA0C5F63D2F0B370F",
"life_cycle_state": "EXECUTED",
"performed_on": null,
"sub_action_type": null,
"behavior_code": "ADD_SERVICE_USAGE"
},
"completed_date": "2017-03-30T21:01:09"
},
{
"authorisation_date": "2017-03-30T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "854BF9FEC6A247EDB117EFA881F84D1C",
"life_cycle_state": "BLOCKED",
"expiration_date": "2017-04-30T21:27:57"
},
{
"cancelled_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"authorisation_date": "2017-03-31T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "65772C04CAF648B78A00175D5BFD6C89",
"life_cycle_state": "CANCELLED",
"expiration_date": "2017-04-30T18:44:53",
"cancellation_date": "2017-03-31T18:46:32"
},
{
"cancelled_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"authorisation_date": "2017-03-31T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "76344A47C1CD413B9E6668BDF46039B2",
"life_cycle_state": "CANCELLED",
"expiration_date": "2017-04-30T18:50:08",
"cancellation_date": "2017-03-31T18:52:19"
},
{
"authorisation_date": "2017-03-31T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "A5B5C6BAAF7444EBB368605B77EF1023",
"life_cycle_state": "BLOCKED",
"expiration_date": "2017-04-30T19:19:04"
},
{
"authorisation_date": "2017-03-31T00:00:00",
"usage_authorisation_services": [],
"authorisation_amount": "50",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "5D7A043EBF904E2B9DA6884687F19AFD",
"life_cycle_state": "BLOCKED",
"expiration_date": "2017-04-30T19:22:05"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST usage_authorisations/create
This method creates a usage authorisation. A single usage authorisation can be created by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
The identifier of the accounts receivable related with the usage authorisation to be created. The allowed accounts receivable identifier fields are the following:
...
authorisation_amount
(mandatory)
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000011921"},
"authorisation_amount":50
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"authorisation_date": "2017-04-04T00:00:00",
"usage_authorisation_services": [
{
"service_family": null,
"maximum_usage": 64,
"service_type": null,
"service": {
"code": "Usage Service 3",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "USTB",
"udr_type": {
"alternative_code": "L",
"name": "Litres",
"description": null,
"id": "B1238270684F4457B6D8EBD4CA00963B"
},
"composition_method": "FLAT",
"name": "Usage Service Type B",
"description": null,
"id": "8FEC7EEE39254E55ABA2C3382C432D2D",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "US3",
"description": "Usage Service 3",
"id": "6444E6324BCE4A34A99DD795E55C016D"
},
"maximum_amount": "0",
"id": "0CFA05C5E5924EEE9D5B19AC3FEE0068"
},
{
"service_family": null,
"maximum_usage": 1,
"service_type": null,
"service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"maximum_amount": "0",
"id": "0C02283A665444C3A6C74FD262364057"
},
{
"service_family": null,
"maximum_usage": 10,
"service_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "USTA",
"udr_type": {
"alternative_code": "L",
"name": "Litres",
"description": null,
"id": "B1238270684F4457B6D8EBD4CA00963B"
},
"composition_method": "FLAT",
"name": "Usage Service Type A",
"description": null,
"id": "819661A2C34A4BBF9005E74387CD7A40",
"classification": "SERVICES",
"physical_good_type": null
},
"service": null,
"maximum_amount": "0",
"id": "EFD35C8D331C46E3A2F7BF6F09D69ABC"
}
],
"authorisation_amount": "50.00",
"accounts_receivable": {
"number": "ACR0000011921",
"name": "ACR0000011921",
"id": "20956A4C18C94A19BE75249D567DBA00",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Allowance_2",
"id": "198E7882488E4B5B936441EE0CE811C0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "AC",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "DEDC131D808742A2A380C0C8D64F5B84",
"life_cycle_state": "BLOCKED",
"expiration_date": "2017-05-04T19:09:00"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST usage_authorisations/cancel
This method cancels an existing usage authorisation. This method can be used only if the specified usage authorisation's life cycle state is set to Blocked. A single usage authorisation can be cancelled by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
String
The identifier of the usage authorisation to be cancelled. The allowed usage authorisation Identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Code Block | ||||||
| ||||||
| Panel | ||||||
| ||||||
|