Create Service Request
Version 1.0.0
Endpoint
POST
https://ebond.att.com/{ebondEnv}/api/clientapi/servicerequest
Copy
Create request is for Client to request creation of a Client Request in the AT&T GPS system.
oauth2
Oauth2 implementation using Client Credentials - client_id & client_secret ProvidedByAT&T
clientCredentials:
scopes:
tokenUrl:https://ebond.att.com/sandbox/EdhREjkedhs234nU/oauth2/token/
Path Parameters
- ebondEnvstringRequiredEnum: [sandbox/EdhREjkedhs234nU]AT&T ebond environmentExample: sandbox/EdhREjkedhs234nU
Query Parameters
- instanceIdstringRequiredClient Instance Id, provided by AT&TExample: instest
- apiKeystringRequiredUnique apikey per Client's instance, provided by AT&TExample: api234key24ljaalkjfiolaskdjfjalllfasd223
- clientIdstringRequiredUnique Client Id per Client, provided by AT&TExample: cli123ijklm4uv
Body Parameters
- object
- statestringThe client's ticket state.Example: OpenLength: 20
- numberstringRequiredRequest number in the customer's system.Example: RITM0032001Length: 30
- sys_idstringRequiredClient unique record ID. Used to link Att item to client item.Example: d9836ba3370233007bc9ded993990ea0Length: 128
- extendedobject
- locationstringCity for the location.Example: testLength: 60
- caller_idstringName of individual using affected asset.Example: Alfonso GriglenLength: 20
- AttAssetIdstringThe unique identifier of the asset as represented in the AT&T system. (NA for client request process)Example: any stringLength: 44
- work_notesstringFree-form text entered by the Customer or agent on behalf of the Customer that they deem as needed in helping to work, resolve the problem or status the Customer.Example: System Administrator (Work notes)\n update for swagger documentation.Length: 2000
- AttSeveritystringEnum: [1, 2, 3, 4, 5, 6]Level of dysfunction from outage, severity level should be start from 1 (Not used for Client Request process).Example: 5Length: 15
- descriptionstringFree-form text entered by the Customer or agent on behalf of the Customer. This should be a high level description of the request being submitted.Example: any stringLength: 4000
- location_zipstringPostal zip code for the location.Example: any stringLength: 20
- location_citystringCity for the location.Example: LondonLength: 60
- resolve_notesstringFree-form text describing problem resolution. Provided by AT&T on closure - not applicable for customer to send to AT&T.Example: any stringLength: 160
- correlation_idstringUnique number identifying the AT&T client request. (This is the AT&T client request).This is not required for client to send as part of create transaction. It will be provided as part of the response from AT&T.Example: any string
- opened_by_namestringName of individual who reported client trouble or request.Example: System AdministratorLength: 43
- caller_id_namestringRequiredName of client contact at client site who gets updates on the status of the requested item. This field is required by Process.Example: System AdministratorLength: 43
- location_statestringState OR Province for the location.Example: any stringLength: 20
- location_streetstringFirst line of the address in location.Example: any stringLength: 60
- opened_by_emailstringEmail address of individual who reported the client trouble or request.Example: admin@example.comLength: 50
- caller_id_emailstringEmail of contact at client site who gets updates on the status of the asset in trouble.Example: admin@example.comLength: 50
- opened_by_phonestringPhone number of the individual who reported client trouble or request.Example: any stringLength: 25
- caller_id_phonestringPhone number of the caller. If caller_id_name is present on the transaction, then this is a required field.Example: any stringLength: 25
- short_descriptionstringValue passed here will represent the Service Line Code or Catalog Item used for GPS purposes. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration.Example: eLCM_LMAC_SECURITYLength: 255
- AttIncidentStatusstringThe status of the ticket as represented in the AT&T incident or ServiceRequest.Example: NewLength: 16
- AttServiceCategorystringRequiredCode that identifies the initial service line. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration.Example: REQUEST-ATT
- caller_id_user_namestringName of contact person, who get updates on the status.Example: adminLength: 25
- AttIncidentOpenDatestringDate/time ticket was opened. This is not required or applicable for Service Request Create/Update transactions from the client.
- AttResolutionActionstringAT&T Code OR description that identifies the action taken to resolve the trouble - Not sent by client on create transactions.Example: any stringLength: 15
- opened_by_user_namestringName of individual who reported client trouble or request.Example: adminLength: 20
- correlation_displaystringExample: att_ebonding
- AttTicketResolveDatestringThis is the date that AT&T resolved the ticket. This typically applies only in transactions from AT&T to client. Not required or applicable from client to AT&T.
- location_countrycodestringISO country code of the location.Example: any stringLength: 20
- AttServiceRestoredDatestringDate/time of service was restored. This is not required or applicable for Service Request Create/Update transactions from the client.
- AttActualCompletionDatestringRepresents the date the ATT request was actually completed in the GPS system. This date is not used or required for Client Create and Update transactions.
- AttSLANegotiatedDueDatestringThe SLA Negotiated Date of the Service Request. This is populated and sent by AT&T from the AT&T request - not applicable for customer to send to AT&T.
Responses
Ok
Body
application/json
- objectRequired
- resultsobject